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

Doc: Rename Doxygen HTML doc directory name liblzma => api. 

When the docs are installed, calling the directory "liblzma" is
confusing since multiple other files in the doc directory are for
liblzma. This should also make it more natural for distros when they
package the documentation.
This commit is contained in:
Jia Tan 2023-03-17 01:30:36 +08:00
parent 94097157fa
commit 8962951173
5 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -38,7 +38,7 @@ build-aux/test-driver
coverage coverage
/doc/internal /doc/internal
/doc/liblzma /doc/api
/src/liblzma/liblzma.pc /src/liblzma/liblzma.pc
/src/lzmainfo/lzmainfo /src/lzmainfo/lzmainfo

18
Makefile.am
View File

@ -47,15 +47,15 @@ dist_examplesold_DATA = \
# Install the Doxygen generated documentation if they were built. # Install the Doxygen generated documentation if they were built.
install-data-local: install-data-local:
if test -d "$(srcdir)/doc/liblzma" ; then \ if test -d "$(srcdir)/doc/api" ; then \
$(MKDIR_P) "$(DESTDIR)$(docdir)/liblzma" && \ $(MKDIR_P) "$(DESTDIR)$(docdir)/api" && \
$(INSTALL_DATA) "$(srcdir)"/doc/liblzma/* \ $(INSTALL_DATA) "$(srcdir)"/doc/api/* \
"$(DESTDIR)$(docdir)/liblzma"; \ "$(DESTDIR)$(docdir)/api"; \
fi fi
# Remove the Doxygen generated documentation when uninstalling. # Remove the Doxygen generated documentation when uninstalling.
uninstall-local: uninstall-local:
rm -rf "$(DESTDIR)$(docdir)/liblzma" rm -rf "$(DESTDIR)$(docdir)/api"
endif endif
EXTRA_DIST = \ EXTRA_DIST = \
@ -112,10 +112,10 @@ dist-hook:
> "$$dest/txt/$$BASE.txt"; \ > "$$dest/txt/$$BASE.txt"; \
done; \ done; \
fi fi
if test -d "$(srcdir)/doc/liblzma" ; then \ if test -d "$(srcdir)/doc/api" ; then \
$(MKDIR_P) "$(distdir)/doc/liblzma" && \ $(MKDIR_P) "$(distdir)/doc/api" && \
$(INSTALL_DATA) "$(srcdir)"/doc/liblzma/* \ $(INSTALL_DATA) "$(srcdir)"/doc/api/* \
"$(distdir)/doc/liblzma"; \ "$(distdir)/doc/api"; \
fi fi
# This works with GNU tar and gives cleaner package than normal 'make dist'. # This works with GNU tar and gives cleaner package than normal 'make dist'.

4
PACKAGERS
View File

@ -171,10 +171,10 @@ Information to packagers of XZ Utils
The Doxygen-generated documentation (HTML) for the liblzma API The Doxygen-generated documentation (HTML) for the liblzma API
headers is included in the source release and will be installed by headers is included in the source release and will be installed by
"make install" to $docdir/liblzma. All JavaScript is removed to "make install" to $docdir/api. All JavaScript is removed to
simplify license compliance and to reduce the install size. If the simplify license compliance and to reduce the install size. If the
liblzma API documentation is not desired, either run configure with liblzma API documentation is not desired, either run configure with
--disable-doc or remove the doc/liblzma directory before running --disable-doc or remove the doc/api directory before running
"make install". "make install".

2
doxygen/Doxyfile
View File

@ -1209,7 +1209,7 @@ GENERATE_HTML = YES
# The default directory is: html. # The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = liblzma HTML_OUTPUT = api
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp). # generated HTML page (for example: .htm, .php, .asp).

18
doxygen/update-doxygen
View File

@ -45,16 +45,16 @@ PACKAGE_VERSION=`cd .. && sh build-aux/version.sh` || exit 1
# If no arguments are specified, default to generating liblzma API header # If no arguments are specified, default to generating liblzma API header
# documentation only. # documentation only.
case $1 in case $1 in
'' | liblzma) '' | api)
# Remove old documentation before re-generating the new. # Remove old documentation before re-generating the new.
rm -rf ../doc/liblzma rm -rf ../doc/api
# Generate the HTML documentation by preparing the Doxyfile # Generate the HTML documentation by preparing the Doxyfile
# in stdin and piping the result to the doxygen command. # in stdin and piping the result to the doxygen command.
# With Doxygen, the last assignment of a value to a tag will # With Doxygen, the last assignment of a value to a tag will
# override any earlier assignment. So, we can use this # override any earlier assignment. So, we can use this
# feature to override the tags that need to change between # feature to override the tags that need to change between
# "liblzma" and "internal" modes. # "api" and "internal" modes.
( (
cat Doxyfile cat Doxyfile
echo "PROJECT_NUMBER = $PACKAGE_VERSION" echo "PROJECT_NUMBER = $PACKAGE_VERSION"
@ -70,14 +70,14 @@ case $1 in
# itself, and doesn't include the actual license text (it # itself, and doesn't include the actual license text (it
# only refers to the MIT license by name). # only refers to the MIT license by name).
echo "Stripping JavaScript from Doxygen output..." echo "Stripping JavaScript from Doxygen output..."
for F in ../doc/liblzma/*.html for F in ../doc/api/*.html
do do
sed 's/<script [^>]*><\/script>//g sed 's/<script [^>]*><\/script>//g
s/onclick="[^"]*"//g' \ s/onclick="[^"]*"//g' \
"$F" > ../doc/liblzma/tmp "$F" > ../doc/api/tmp
mv -f ../doc/liblzma/tmp "$F" mv -f ../doc/api/tmp "$F"
done done
rm -f ../doc/liblzma/*.js rm -f ../doc/api/*.js
;; ;;
internal) internal)
@ -102,8 +102,8 @@ case $1 in
echo "doxygen/update-doxygen: Error: mode argument '$1'" \ echo "doxygen/update-doxygen: Error: mode argument '$1'" \
"is not supported." >&2 "is not supported." >&2
echo "doxygen/update-doxygen: Supported modes:" >&2 echo "doxygen/update-doxygen: Supported modes:" >&2
echo "doxygen/update-doxygen: - 'liblzma' (default):" \ echo "doxygen/update-doxygen: - 'api' (default):" \
"API docs into doc/liblzma" >&2 "liblzma API docs into doc/api" >&2
echo "doxygen/update-doxygen: - 'internal':"\ echo "doxygen/update-doxygen: - 'internal':"\
"internal docs into doc/internal" >&2 "internal docs into doc/internal" >&2
exit 1 exit 1