mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-01 07:25:47 +03:00
Olaf Bergmann
2991da5547
Ensure that EXTRA_DIST contents are included in make dist even if configured without documentation. CLEANFILES is also set outside the conditional area to enable proper cleanup.
193 lines
8.6 KiB
Makefile
193 lines
8.6 KiB
Makefile
# doc/Makefile.am
|
|
#
|
|
# Copyright (C) 2015-2018 Carsten Schoenert <c.schoenert@t-online.de>
|
|
# 2018 Jon Shallow <supjps-libcoap@jpshallow.com>
|
|
#
|
|
# This file is part of the CoAP C library libcoap. Please see README and
|
|
# COPYING for terms of use.
|
|
|
|
|
|
# We can only perfom the targets in this directory if doxygen is present.
|
|
|
|
CLEANFILES = \
|
|
doxygen_sqlite3.db
|
|
|
|
EXTRA_DIST = \
|
|
docbook.local.css \
|
|
upgrade_4.2.1_4.3.0.txt \
|
|
main.md
|
|
|
|
if HAVE_DOXYGEN
|
|
|
|
man-page-cleanup:
|
|
@rm -f $(top_builddir)/doc/DoxygenLayout.xml
|
|
@rm -rf $(top_builddir)/doc/man_tmp
|
|
@rm -rf $(top_builddir)/doc/man_html
|
|
|
|
man-page-prepare: man-page-cleanup
|
|
@$(MKDIR_P) $(top_builddir)/doc/man_tmp
|
|
@$(MKDIR_P) $(top_builddir)/doc/man_html
|
|
|
|
man-page-start: man-page-prepare
|
|
## Setup the man page tab
|
|
@echo ' <tab type="usergroup" visible="yes" url="@ref manpage" title="Manual Pages">' > $(top_builddir)/doc/insert_file
|
|
@echo '/** @page manpage Manual Pages' > $(top_builddir)/doc/man_tmp/manpage.dox
|
|
@echo ' Here is a list of libcoap API manual pages, some of which have code examples:' >> $(top_builddir)/doc/man_tmp/manpage.dox
|
|
@echo ' <table class="directory">' >> $(top_builddir)/doc/man_tmp/manpage.dox
|
|
## Setup the upgrading tab
|
|
@echo '/** @page upgrading Upgrading' > $(top_builddir)/doc/man_tmp/upgrading.dox
|
|
@echo ' Upgrading between libcoap versions:' >> $(top_builddir)/doc/man_tmp/upgrading.dox
|
|
@echo ' <table class="directory">' >> $(top_builddir)/doc/man_tmp/upgrading.dox
|
|
|
|
man-page-build: upg-page-build man-page-start
|
|
@MAN_FILES=`find $(top_srcdir)/man/ -type f -name "coap.txt.in" ; find $(top_srcdir)/man/ -type f -name "coap_*.in" | ALL=C sort ; find $(top_srcdir)/man/ -type f -name "coap-*.in" | LC_ALL=C sort` ;\
|
|
UPG_FILES=`find $(top_srcdir)/doc/ -type f -name "upgrade_*.txt" | ALL=C sort` ;\
|
|
HTML_FILES=`find $(top_builddir)/man/ -type f -name "*.html"` ;\
|
|
COUNT_MAN_FILES=`echo $${MAN_FILES} | wc -w` ;\
|
|
COUNT_HTML_FILES=`echo $${HTML_FILES} | wc -w` ;\
|
|
## We need the HTML files from the Asciidoc source files, check if they around, otherwise build them.
|
|
if [ "$${COUNT_MAN_FILES}" != "$${COUNT_HTML_FILES}" ]; then \
|
|
$(MAKE) -C ../man ;\
|
|
fi ;\
|
|
for FILE in $${MAN_FILES} ; do \
|
|
BASE=`basename $${FILE} | cut -d. -f 1` ;\
|
|
MANUAL=`egrep -B 1 "^====" $${FILE} | head -1` ;\
|
|
SUMMARY=`egrep -B 2 "^SYNOPSIS" $${FILE} | sed 's/coap-//g' | cut -d\- -f2 | cut -c2- | head -1` ;\
|
|
## Build the manual insert page
|
|
echo "/// @page man_$${BASE} $${MANUAL}" > $(top_builddir)/doc/man_tmp/$${MANUAL}.dox ;\
|
|
echo "/// @htmlinclude $${BASE}.html $${MANUAL}" >> $(top_builddir)/doc/man_tmp/$${MANUAL}.dox ;\
|
|
## Update insert_file
|
|
echo " <tab type=\"user\" visible=\"yes\" url=\"@ref man_$${BASE}\" title=\"$${MANUAL} - $${SUMMARY}\" intro=\"\"/>" >> $(top_builddir)/doc/insert_file ;\
|
|
## Update the summary man page
|
|
echo " <tr id=\"row_$${ID}_\"$${ROW_EVEN}>" >> $(top_builddir)/doc/man_tmp/manpage.dox ;\
|
|
echo " <td class=\"entry\" align=\"left\"> @ref man_$${BASE} </td><td class=\"desc\" align=\"left\">$${MANUAL} - $${SUMMARY}</td>" >> $(top_builddir)/doc/man_tmp/manpage.dox ;\
|
|
echo " </tr>" >> $(top_builddir)/doc/man_tmp/manpage.dox ;\
|
|
if [ -z $${ROW_EVEN} ] ; then \
|
|
ROW_EVEN=" class=\"even\"" ;\
|
|
else \
|
|
ROW_EVEN= ;\
|
|
fi \
|
|
done ;\
|
|
## Close off the man page file
|
|
echo ' </table>' >> $(top_builddir)/doc/man_tmp/manpage.dox ;\
|
|
echo ' */' >> $(top_builddir)/doc/man_tmp/manpage.dox ;\
|
|
echo ' </tab>' >> $(top_builddir)/doc/insert_file ;\
|
|
## Add in the deprecated tab
|
|
echo ' <tab type="user" visible="yes" url="@ref deprecated" title="Deprecated Items" intro=""/>' >> $(top_builddir)/doc/insert_file ;\
|
|
## Start the upgrade tab
|
|
echo ' <tab type="usergroup" visible="yes" url="@ref upgrading" title="Upgrading">' >> $(top_builddir)/doc/insert_file ;\
|
|
for FILE in $${UPG_FILES} ; do \
|
|
BASE=`basename $${FILE} | $(SED) "s/\.txt$$//g"`; \
|
|
UPGRADE=`echo $${BASE} | $(SED) "s/^upgrade_//g"`; \
|
|
CUPGRADE=`echo $${UPGRADE} | $(SED) "s/\./-/g"`; \
|
|
SUMMARY=`head -1 $${FILE} | sed 's/^= //g'` ;\
|
|
## Build the upgrade insert page
|
|
echo "/// @page upg_$${CUPGRADE} $${UPGRADE}" > $(top_builddir)/doc/man_tmp/$${UPGRADE}.dox ;\
|
|
echo "/// @htmlinclude $${BASE}.html $${UPGRADE}" >> $(top_builddir)/doc/man_tmp/$${UPGRADE}.dox ;\
|
|
## Update insert_file
|
|
echo " <tab type=\"user\" visible=\"yes\" url=\"@ref upg_$${CUPGRADE}\" title=\"$${SUMMARY}\" intro=\"\"/>" >> $(top_builddir)/doc/insert_file ;\
|
|
## Update the upgrading page
|
|
echo " <tr id=\"row_$${ID}_\"$${ROW_EVEN}>" >> $(top_builddir)/doc/man_tmp/upgrading.dox ;\
|
|
echo " <td class=\"entry\" align=\"left\"> @ref upg_$${CUPGRADE} </td><td class=\"desc\" align=\"left\">$${SUMMARY}</td>" >> $(top_builddir)/doc/man_tmp/upgrading.dox ;\
|
|
echo " </tr>" >> $(top_builddir)/doc/man_tmp/upgrading.dox ;\
|
|
if [ -z $${ROW_EVEN} ] ; then \
|
|
ROW_EVEN=" class=\"even\"" ;\
|
|
else \
|
|
ROW_EVEN= ;\
|
|
fi ;\
|
|
if [ -f $(top_builddir)/doc/$${BASE}.html ]; then \
|
|
cp -f $(top_builddir)/doc/$${BASE}.html $(top_builddir)/doc/man_html/$${BASE}.html ;\
|
|
## Correct case sensitive Name and Synopsis
|
|
$(SED) -i 's^<div class="toc"><p><strong>^<div class="section"><p><strong>^' $(top_builddir)/doc/man_html/$${BASE}.html ;\
|
|
else \
|
|
echo "ERROR: $(top_builddir)/doc/$${BASE}.html not found!";\
|
|
exit 1 ;\
|
|
fi \
|
|
done ;\
|
|
## Close off the upgrading tab
|
|
echo ' </table>' >> $(top_builddir)/doc/man_tmp/upgrading.dox ;\
|
|
echo ' */' >> $(top_builddir)/doc/man_tmp/upgrading.dox ;\
|
|
echo ' </tab>' >> $(top_builddir)/doc/insert_file ;\
|
|
## Create and Update the DoxygenLayout.xml file
|
|
$(DOXYGEN) -l ;\
|
|
$(SED) -i 's/<tab type="pages" visible="yes" /<tab type="pages" visible="no" /g' $(top_builddir)/doc/DoxygenLayout.xml ;\
|
|
$(SED) -i '/<tab type="examples" visible=.*/r insert_file' $(top_builddir)/doc/DoxygenLayout.xml ;\
|
|
$(RM) $(top_builddir)/doc/insert_file ;\
|
|
## Fix up man html files, fixing links, UC Name and Synopsis
|
|
for FILE in $${MAN_FILES} ; do \
|
|
BASE=`basename $${FILE} | cut -d . -f1` ;\
|
|
if [ -f $(top_builddir)/man/$${BASE}.html ]; then \
|
|
cp -f $(top_builddir)/man/$${BASE}.html $(top_builddir)/doc/man_html/$${BASE}.html ;\
|
|
## Correct case sensitive Name and Synopsis
|
|
$(SED) -i 's^<h2>Name</h2>^<h2>NAME</h2>^g' $(top_builddir)/doc/man_html/$${BASE}.html ;\
|
|
$(SED) -i 's^<h2>Synopsis</h2>^<h2>SYNOPSIS</h2>^g' $(top_builddir)/doc/man_html/$${BASE}.html ;\
|
|
else \
|
|
echo "ERROR: $(top_builddir)/man/$${BASE}.html not found!";\
|
|
exit 1 ;\
|
|
fi ;\
|
|
for ENTRY in $${MAN_FILES} ; do \
|
|
EBASE=`basename $${ENTRY} | cut -d . -f1` ;\
|
|
MANUAL=`egrep -B 1 "^====" $${ENTRY} | head -1` ;\
|
|
SECTION=`echo $${MANUAL} | cut -d\( -f2 | cut -d\) -f1` ;\
|
|
$(SED) -i "s^<span class=\"strong\"><strong>$${EBASE}</strong></span>($${SECTION})^<a href=\"man_$${EBASE}.html\" target=\"_self\"><span class=\"strong\"><strong>$${EBASE}</strong></span>($${SECTION})</a>^g" $(top_builddir)/doc/man_html/$${BASE}.html ;\
|
|
done ;\
|
|
echo "finalized addition $${BASE}.html" ;\
|
|
done
|
|
|
|
if BUILD_MANPAGES
|
|
UPG_LIST = upgrade_4.2.1_4.3.0.txt
|
|
|
|
upg-page-build:
|
|
@for FILE in $(UPG_LIST) ; do \
|
|
$(A2X) -d article --format xhtml -D $(top_builddir)/doc/ $(top_srcdir)/doc/$${FILE} ;\
|
|
done
|
|
|
|
all: man-page-build
|
|
$(DOXYGEN) Doxyfile
|
|
@cp -f $(top_srcdir)/doc/docbook.local.css $(top_builddir)/doc/html/docbook-xsl.css
|
|
|
|
else
|
|
#
|
|
# Need to make sure the man directories are in place, but empty
|
|
all: man-page-prepare
|
|
$(DOXYGEN) Doxyfile
|
|
endif # BUILD_MANPAGES
|
|
|
|
clean-local:
|
|
-rm -rf $(top_builddir)/doc/html $(top_builddir)/doc/man_tmp $(top_builddir)/doc/man_html $(top_builddir)/doc/DoxygenLayout.xml $(top_builddir)/doc/docbook-xsl.css $(top_builddir)/doc/*.html
|
|
|
|
distclean-local: clean-local
|
|
|
|
endif # HAVE_DOXYGEN
|
|
|
|
install-data-hook:
|
|
if HAVE_DOXYGEN
|
|
@if [ ! -d $(top_builddir)/doc/html ]; then \
|
|
echo ;\
|
|
echo " No install data in '$(top_builddir)/doc/html'found! Please run 'make all' first." ;\
|
|
echo ;\
|
|
exit 1 ;\
|
|
fi
|
|
$(MKDIR_P) $(DESTDIR)$(htmldir)/html || exit 1
|
|
cp -a -f $(top_builddir)/doc/html $(DESTDIR)$(htmldir)
|
|
find $(DESTDIR)$(htmldir) -type f -name "*.md5" -delete
|
|
endif # HAVE_DOXYGEN
|
|
if BUILD_LICENSE_INSTALL
|
|
$(MKDIR_P) $(DESTDIR)$(docdir) || exit 1
|
|
$(INSTALL_DATA) $(top_srcdir)/LICENSE $(DESTDIR)$(docdir)
|
|
$(INSTALL_DATA) $(top_srcdir)/COPYING $(DESTDIR)$(docdir)
|
|
$(INSTALL_DATA) $(top_srcdir)/README $(DESTDIR)$(docdir)
|
|
endif # BUILD_LICENSE_INSTALL
|
|
|
|
uninstall-hook:
|
|
if BUILD_LICENSE_INSTALL
|
|
@if [ -d $(DESTDIR)$(docdir) ] ; then \
|
|
(cd $(DESTDIR)$(docdir) ; rm -f LICENSE README COPYING) ; \
|
|
fi
|
|
endif # BUILD_LICENSE_INSTALL
|
|
if HAVE_DOXYGEN
|
|
-rm -rf $(DESTDIR)$(htmldir)/html
|
|
endif # HAVE_DOXYGEN
|
|
|
|
.PHONY: man-page-cleanup man-page-prepare man-page-start man-page-build
|