This is the magic trick to get rid of files like NEWS, INSTALL,
etc. that are unused in some projects, like libnl.
Signed-off-by: Jan Engelhardt <jengelh@inai.de>
On a second thought, don't include doc/ in dist at all and distribute it
separately. The doc source files are available in the git tree anyway.
Signed-off-by: Thomas Graf <tgraf@redhat.com>
Separates all the documentation generation trickery to its own
configure.in and allows to easily generate a pre built doc dist
file for distribution.
Arguments to configure will be passed on to doc/configure
Signed-off-by: Thomas Graf <tgraf@redhat.com>
New functions:
rtnl_link_set_group(link, group)
rtnl_link_get_group(link)
The group identifier is printed in the brief section as "group N"
Signed-off-by: Thomas Graf <tgraf@redhat.com>
- 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
Adds a new section to netlink fundamentals explaining the common
addressing use cases and illustrates kernel->user, user->user,
and user->kernel communication.
Adds --enable-doc/--disable-doc, if omitted doc will only be build
if requirements are met. If explicitely enabled, configure script
will fail if requirements are not met.
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)
- 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
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
- 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
Issues solved:
* PACKAGE_VERSION was abused for SOVERSION
* unneeded DEP stage
* did not support out-of-tree builds
* no way to turn off silent mode
* overriding CFLAGS at make time was not supported
* no static libs were provided
Signed-off-by: Jan Engelhardt <jengelh@medozas.de>
