aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-03-16 21:41:09 +0800
committerJia Tan <jiat0218@gmail.com>2023-03-17 01:42:28 +0800
commit8979308528c1f45cb9ee52d511f05232b4ad90a1 (patch)
treec87d88b5800291616715970188658ed051fb6804
parentliblzma: Add set lzma.h as the main page for Doxygen documentation. (diff)
downloadxz-8979308528c1f45cb9ee52d511f05232b4ad90a1.tar.xz
Doc: Update PACKAGERS with details about liblzma API docs install.
-rw-r--r--PACKAGERS22
1 files changed, 16 insertions, 6 deletions
diff --git a/PACKAGERS b/PACKAGERS
index b3b05090..521dd4e4 100644
--- a/PACKAGERS
+++ b/PACKAGERS
@@ -44,6 +44,8 @@ Information to packagers of XZ Utils
lzmadec binary for compatibility with LZMA Utils
liblzma liblzma.so.*
liblzma-devel liblzma.so, liblzma.a, API headers
+ liblzma-doc Doxygen-generated liblzma API docs (HTML),
+ example programs
2. Package description
@@ -109,6 +111,13 @@ Information to packagers of XZ Utils
This package includes the API headers, static library, and
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
----------
@@ -160,12 +169,13 @@ Information to packagers of XZ Utils
can be replaced with a symlink if your distro ships with shared
copies of the common license texts.
- liblzma API is currently only documented using Doxygen tags in the
- API headers. It hasn't been tested much how good results Doxygen
- is able to make from the tags (e.g. Doxyfile might need tweaking,
- the tagging may need to be improved etc.), so it might be simpler
- to just let people read docs directly from the .h files for now,
- and also save quite a bit in package size at the same time.
+ The Doxygen-generated documentation (HTML) for the liblzma API
+ headers is included in the source release and will be installed by
+ "make install" to $docdir/liblzma. All JavaScript is removed to
+ simplify license compliance and to reduce the install size. If the
+ liblzma API documentation is not desired, either run configure with
+ --disable-doc or remove the doc/liblzma directory before running
+ "make install".
6. Extra files