mirror of
https://github.com/libevent/libevent.git
synced 2025-01-09 00:56:20 +08:00
19d0bdfe0c
As pointed by @kloczek: "With only two characters it would be harder to guess under what kind of name are libevent lvl 3 man pages. Longer name with bash/fix/zsh tab competition should not be a problem :)" Refs: #1099
81 lines
2.6 KiB
Plaintext
81 lines
2.6 KiB
Plaintext
# Doxygen documentation will not be generated with default configuration,
|
|
# unless '--enable-doxygen-doc' is configured.
|
|
# The following targets are all about doxygen:
|
|
# make # 'make doxygen' would be auto executed
|
|
# make doxygen # generating doxygen documentation
|
|
# make doxygen-doc # same as 'make doxygen'
|
|
# make clean # clean docs generated by doxygen
|
|
# make install # install doxygen documentation
|
|
# make uninstall # uninstall doxygen documentation
|
|
|
|
if ENABLE_DOXYGEN
|
|
|
|
# Add all needed rules defined in ax_prog_doxygen.m4
|
|
@DX_RULES@
|
|
|
|
# Use 'make clean' to clean docs generated by doxygen.
|
|
clean-local:
|
|
-rm -rf $(DX_CLEANFILES)
|
|
|
|
if ENABLE_DOXYGEN_MAN
|
|
man3_MAN_DIR = @DX_DOCDIR@/man/man3
|
|
|
|
# add "libevent_" prefix for man pages
|
|
#
|
|
# XXX: we cannot clean old man pages here since
|
|
# doxygen-rename-man-pages will be called twice:
|
|
# - for make
|
|
# - for make install
|
|
# (cmake works differently)
|
|
#
|
|
# Once this will be solved add the following to the target:
|
|
#
|
|
# -rm -fr $(man3_MAN_DIR)/libevent_*
|
|
doxygen-rename-man-pages: doxygen-doc
|
|
echo "Rename man pages in $(man3_MAN_DIR)"
|
|
@for p in $(man3_MAN_DIR)/*; do \
|
|
p=`basename $$p`; \
|
|
p_strip=$${p/libevent_/}; \
|
|
if [ ! "$$p_strip" = "$$p" ]; then continue; fi; \
|
|
mv '$(man3_MAN_DIR)/'$$p '$(man3_MAN_DIR)/'libevent_$$p; \
|
|
done
|
|
|
|
# integrate doxygen with automake targets
|
|
man3_MANS = $(man3_MAN_DIR)/*
|
|
$(man3_MANS): doxygen-doc doxygen-rename-man-pages
|
|
endif ENABLE_DOXYGEN_MAN
|
|
|
|
# Docs will be installed. It may be one or more docs supported
|
|
# by doxygen, but does not include 'man'.
|
|
docdirs = $(DX_INSTALL_DOCS)
|
|
|
|
# Rules for installing docs generated by doxygen into $(htmldir),
|
|
# The typical value of $(htmldir) is '/usr/local/share/doc/$(PACKAGE)'
|
|
install-data-local:
|
|
@if ! test -d "$(DESTDIR)$(htmldir)"; then \
|
|
echo "$(mkinstalldirs) '$(DESTDIR)$(htmldir)'"; \
|
|
$(mkinstalldirs) '$(DESTDIR)$(htmldir)'; \
|
|
fi
|
|
@for d in $(docdirs); do \
|
|
echo "cp -pR $$d '$(DESTDIR)$(htmldir)/'"; \
|
|
cp -pR $$d '$(DESTDIR)$(htmldir)/'; \
|
|
done
|
|
|
|
# Rules for uninstalling docs generated by doxygen from $(htmldir)
|
|
uninstall-local:
|
|
@for d in $(docdirs); do \
|
|
d=`basename $$d`; \
|
|
echo "test ! -d '$(DESTDIR)$(htmldir)/'$$d || \
|
|
{ find '$(DESTDIR)$(htmldir)/'$$d -type d ! -perm -200 -exec chmod u+w '{}' ';' && \
|
|
rm -rf '$(DESTDIR)$(htmldir)/'$$d; }"; \
|
|
test ! -d '$(DESTDIR)$(htmldir)/'$$d || \
|
|
{ find '$(DESTDIR)$(htmldir)/'$$d -type d ! -perm -200 -exec chmod u+w '{}' ';' && \
|
|
rm -rf '$(DESTDIR)$(htmldir)/'$$d; }; \
|
|
done
|
|
rmdir "$(DESTDIR)$(htmldir)/" || true
|
|
|
|
doxygen: doxygen-doc
|
|
all: doxygen
|
|
|
|
endif ENABLE_DOXYGEN
|