diff options
author | Thomas Graf <tgraf@suug.ch> | 2010-11-19 01:25:37 (GMT) |
---|---|---|
committer | Thomas Graf <tgraf@suug.ch> | 2010-11-19 01:25:37 (GMT) |
commit | 6545206187c97136d69c5a456257cafa104667bc (patch) | |
tree | 0da17b738942c485f57853e0c3400e4fba531c5a /doc/src/toc.c | |
parent | 5a08c8ff4cf9573f307ef2843d2a44f1f0a14980 (diff) | |
download | libnl-6545206187c97136d69c5a456257cafa104667bc.zip libnl-6545206187c97136d69c5a456257cafa104667bc.tar.gz libnl-6545206187c97136d69c5a456257cafa104667bc.tar.bz2 |
Documentation updates
- moved documentation from lib/doc.c to doc/src/
- splitted pages into separate files
- worked over core sections, explaining the receiving and sending
behaviour in much more details including the the available
mechanisms to customize the behaviour
- updated the html stylesheet file for increased readability, probably
needs some doxygen patching to achieve what I am looking for.
- enabled call graphs, not expanded by default
Diffstat (limited to 'doc/src/toc.c')
-rw-r--r-- | doc/src/toc.c | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/src/toc.c b/doc/src/toc.c new file mode 100644 index 0000000..c33727c --- /dev/null +++ b/doc/src/toc.c @@ -0,0 +1,66 @@ +/** + * \cond skip + * vim:syntax=doxygen + * \endcond + +\mainpage + +\section main_intro Introduction + +libnl is a set of libraries to deal with the netlink protocol and some +of the high level protocols implemented on top of it. The goal is to +provide APIs on different levels of abstraction. The core library libnl.so +provides a fundamental set of functions to deal with sockets, construct +messages, and send/receive those messages. Additional high level interfaces +for several individual netlink protocols are provided in separate +libraries (e.g. \ref route_doc "nl-route.so", \ref genl_doc "nl-genl.so", ...). + +The library is designed to ensure that all components are optional, i.e. +even though the core library provides a caching system which allows to +easly manage objects of any kind, no application is required to use this +caching system if it has no need for it. + +The library was developed and tested on 2.6.x kernel releases. It may +or may not work with older kernel series. Also, although all netlink +protocols are required to maintain backwards compatibility, this has not +always achieved and undesired side effects can occur if a recent libnl +version is used with a considerably older kernel. + +\section main_toc Table of Contents + +- \subpage core_doc "1. Netlink Core Library (-lnl)" +- \subpage route_doc "2. Routing Netlink Library (-lnl-route)" +- \subpage genl_doc "3. Generic Netlink Library (-lnl-genl)" +- \subpage nf_doc "4. Netfilter Netlink Library (-lnl-nf)" + +\section main_trees GIT Trees + +\subsection tree_dev Development Tree + +@code +git://git.kernel.org/pub/scm/libs/netlink/libnl.git +@endcode +- Web: http://www.kernel.org/pub/scm/libs/netlink/libnl.git + +\subsection tree_stable Stable Tree + +@code +git://git.kernel.org/pub/scm/libs/netlink/libnl-stable.git +@endcode +- Web: http://www.kernel.org/pub/scm/libs/netlink/libnl-stable.git + +\section main_website Website + +- http://www.infradead.org/~tgr/libnl/ + +\section main_mailinglist Mailinglist + +Please post question and patches to the libnl mailinglist: + +@code +libnl@lists.infradead.org +@endcode + +- Archives: http://canuck.infradead.org/pipermail/libnl/ + +*/ |