revi-archive/xz-archive
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
Code Activity

Doc: Update PACKAGERS with details about liblzma API docs install.

Browse source
This commit is contained in:
Jia Tan 2023-03-16 21:41:09 +08:00
parent 7e2fa48bb7
commit e57c74f9ef
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
PACKAGERS
View file

@ -44,6 +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),
example programs
2. Package description 2. Package description
@ -109,6 +111,13 @@ Information to packagers of XZ Utils
This package includes the API headers, static library, and This package includes the API headers, static library, and
other development files related to liblzma. other development files related to liblzma.
liblzma-doc:
liblzma API documentation in HTML and example usage
This package includes the Doxygen-generated liblzma API
HTML docs and example programs showing how to use liblzma.
3. License 3. License
---------- ----------
@ -160,12 +169,13 @@ 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.
liblzma API is currently only documented using Doxygen tags in the The Doxygen-generated documentation (HTML) for the liblzma API
API headers. It hasn't been tested much how good results Doxygen headers is included in the source release and will be installed by
is able to make from the tags (e.g. Doxyfile might need tweaking, "make install" to $docdir/liblzma. All JavaScript is removed to
the tagging may need to be improved etc.), so it might be simpler simplify license compliance and to reduce the install size. If the
to just let people read docs directly from the .h files for now, liblzma API documentation is not desired, either run configure with
and also save quite a bit in package size at the same time. --disable-doc or remove the doc/liblzma directory before running
"make install".
6. Extra files 6. Extra files