dect
/
libnl
Archived
13
0
Fork 0
Commit Graph

11 Commits

Author SHA1 Message Date
Thomas Graf fec10a2823 doc: documentation restructuring
- changes the modules hierarchy to better represent the set of libaries
- list the header file that needs to be included
- remove examples/doc from api ref that is included in the guide
- add references to the guide
- fix doxygen api linking for version 1.8.0
- readd doxygen mainpage to config file
- fix a couple of doxygen doc bugs
2012-05-10 12:03:59 +02:00
Thomas Graf 2fbab02ba8 doc: add section about addressing
Adds a new section to netlink fundamentals explaining the common
addressing use cases and illustrates kernel->user, user->user,
and user->kernel communication.
2012-05-09 15:02:40 +02:00
Thomas Graf c55acc438b cache_manager: Move documentation to doc/core.txt 2012-04-21 11:38:33 +02:00
Thomas Graf 7d47666eb3 doc: Fix incorrect nl_socket_add_memberships() example
Reported by: Andrew Collins <bsderandrew@gmail.com>
Signed-off-by: Thomas Graf <tgraf@redhat.com>
2012-03-26 14:02:25 +02:00
Thomas Graf f7d06614fc doc: Fix typos in autoconf example
Reported by nick black <dankamongmen@gmail.com>
2012-02-23 00:20:45 +01:00
Thomas Graf 4c210adcb5 Switch to libtool versioning system
It has been a request that multiple libnl versions should be installabe
in parallel.

In order to achieve this, the basename of the library was changed to
libnl-3 which reflects the 3rd generation of libnl APIs. It also means
that release based library versioning is left behind and libtool
versioning is used instead.

Projects using pkgconfig will automatically link against the new library
basename and will not notice a difference.

The SO versioning is based on the glib model:
  current := 100 * minor + micro - revision
  revision := revision
  age := age (number of backwards compatible versions)
2011-09-13 22:58:08 +02:00
Thomas Graf f1c8d5b0a3 3.1 release 2011-08-11 14:30:24 +02:00
Thomas Graf 50074732af more documentation updates
- improved stylesheets for both doxygen and asciidoc
 - use of xml doxygen layout
 - python script to resolve <<foo>> asciidoc references to
   <<foo, title>> based on the target caption
 - graphics for netlink and netlink error headers
 - more link documentation
2011-07-21 16:24:31 +02:00
Thomas Graf 7d484555f6 Documentation updates
- update to asciidoc 8.6.5
- added doc/README
- switched to toc2
- started adding link documentation
2011-07-18 08:50:42 +02:00
Thomas Graf 63548f5664 documentation updates 2011-07-14 12:48:00 +02:00
Thomas Graf 350b15f9d1 Move to asciidoc
The core library documentation has been converted to use asciidoc. It
provides better flexibility in creating documentation such as tables
and more powerful formatting rules.

The doxygen based API reference remains and three scripts have been
added to:
 - gen-tags.sh: extract tag information from doxygen reference
 - tags2dict.sh: generate a name=link dictionary file
 - doxygen-link.py: replace all references in the asciidoc documentation
                    refering to API functions, struct, etc. with a link
		    into the doxygen API reference.

'make gendoc' continue to generate all documentation.

The following tools are required to generate documentation:
 - asciidoc
 - mscgen
 - asciidoc mscgen plugin
 - pygments
 - xmlstarlet
2011-03-31 14:25:57 +02:00