root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

PACKAGERS: Document the optional Doxygen usage 

Also add a note that packagers should check the licensing
of the Doxygen output.

(cherry picked from commit 541406bee3)
This commit is contained in:
Lasse Collin 2024-04-19 15:16:42 +03:00
parent 28e7d130cb
commit f7c9bab037
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
PACKAGERS
View File

@ -44,8 +44,8 @@ Information to packagers of XZ Utils
lzmadec binary for compatibility with LZMA Utils lzmadec binary for compatibility with LZMA Utils
liblzma liblzma.so.* liblzma liblzma.so.*
liblzma-devel liblzma.so, liblzma.a, API headers liblzma-devel liblzma.so, liblzma.a, API headers
liblzma-doc Doxygen-generated liblzma API docs (HTML), liblzma-doc Example programs and, if enabled at build time,
example programs Doxygen-generated liblzma API docs (HTML)
2. Package description 2. Package description
@ -170,13 +170,14 @@ Information to packagers of XZ Utils
can be replaced with a symlink if your distro ships with shared can be replaced with a symlink if your distro ships with shared
copies of the common license texts. copies of the common license texts.
The Doxygen-generated documentation (HTML) for the liblzma API The Doxygen-generated liblzma API documentation (HTML) is built and
headers is included in the source release and will be installed by installed if the configure option --enable-doxygen is used (it's
"make install" to $docdir/api. All JavaScript is removed to disabled by default). This requires that Doxygen is available. The
simplify license compliance and to reduce the install size. If the API documentation is installed by "make install" to $docdir/api.
liblzma API documentation is not desired, either run configure with
--disable-doc or remove the doc/api directory before running NOTE: The files generated by Doxygen include content from
"make install". Doxygen itself. Check the license info before distributing
the Doxygen-generated files.
6. Extra files 6. Extra files