From 35cee1e39c0ca6bd35f2bb0c18ad6ffca5cc7108 Mon Sep 17 00:00:00 2001 From: Kurtis Rader Date: Wed, 30 Mar 2016 15:35:14 -0700 Subject: remove "doc" make target and rename "user_doc" Fixes #2874 --- Makefile.in | 30 ++++++++++++------------------ build_tools/make_tarball.sh | 2 +- doc_src/FORMATTING.md | 2 +- 3 files changed, 14 insertions(+), 20 deletions(-) diff --git a/Makefile.in b/Makefile.in index 056a3d81..c68d7aa5 100644 --- a/Makefile.in +++ b/Makefile.in @@ -266,29 +266,23 @@ prof: all # # User documentation, describing the features of the fish shell. # - -# Depend on the sources (*.hdr.in) and manually make the -# intermediate *.hdr and doc.h files if needed -# The sed command deletes everything including and after the first -, for simpler version numbers -# Cleans up the user_doc/html directory once Doxygen is done. - -user_doc: $(HDR_FILES_SRC) Doxyfile.user $(HTML_SRC) $(HELP_SRC) doc.h $(HDR_FILES) lexicon_filter - (cat Doxyfile.user; echo INPUT_FILTER=./lexicon_filter; \ - echo PROJECT_NUMBER=$(FISH_BUILD_VERSION) | $(SED) "s/-.*//") | doxygen - && touch user_doc; \ - cd user_doc/html && rm -f bc_s.png bdwn.png closed.png ftv2*.png nav*.png open.png sync_*.png tab*.* doxygen.* dynsections.js jquery.js pages.html - -# -# Source code documentation. Also includes user documentation. +# Depend on the sources (*.hdr.in) and manually make the intermediate *.hdr +# and doc.h files if needed. The sed command deletes everything including and +# after the first -, for simpler version numbers. Cleans up the user_doc/html +# directory once Doxygen is done. # - -doc: src/*.h src/*.cpp doc.h Doxyfile lexicon_filter - (cat Doxyfile; echo INPUT_FILTER=./lexicon_filter; echo PROJECT_NUMBER=$(FISH_BUILD_VERSION)) | doxygen - ; - +doc: $(HDR_FILES_SRC) Doxyfile.user $(HTML_SRC) $(HELP_SRC) doc.h \ + $(HDR_FILES) lexicon_filter + (cat Doxyfile.user; echo INPUT_FILTER=./lexicon_filter; \ + echo PROJECT_NUMBER=$(FISH_BUILD_VERSION) | $(SED) "s/-.*//") | \ + doxygen - && touch user_doc; \ + cd user_doc/html && rm -f bc_s.png bdwn.png closed.png ftv2*.png \ + nav*.png open.png sync_*.png tab*.* doxygen.* dynsections.js \ + jquery.js pages.html # # PDF version of the source code documentation. # - doc/refman.pdf: doc cd doc/latex && \ make && \ diff --git a/build_tools/make_tarball.sh b/build_tools/make_tarball.sh index 4f02411b..1e24de0f 100755 --- a/build_tools/make_tarball.sh +++ b/build_tools/make_tarball.sh @@ -37,7 +37,7 @@ git archive --format=tar --prefix="$prefix"/ HEAD > "$path" # Don't run autoheader since configure.ac runs it. autoconf is enough. autoconf ./configure --with-doxygen -make user_doc share/man +make doc share/man echo $VERSION > version cd /tmp rm -f "$prefix" diff --git a/doc_src/FORMATTING.md b/doc_src/FORMATTING.md index 0a44f355..0ae1c81e 100644 --- a/doc_src/FORMATTING.md +++ b/doc_src/FORMATTING.md @@ -56,7 +56,7 @@ is transformed into: `@cmnd{echo} @args{hello} @args{world}` -which is then transformed by Doxygen into an HTML version (`make user_doc`): +which is then transformed by Doxygen into an HTML version (`make doc`): `echo hello world` -- cgit v1.2.3