[rtems commit] doc: Use More Readable Names for Generated Nodes

Joel Sherrill joel at rtems.org
Tue Feb 26 13:59:05 UTC 2013


Module:    rtems
Branch:    master
Commit:    0c59b4bb83ec68cf498f6ebaa5d3ee806c03ed32
Changeset: http://git.rtems.org/rtems/commit/?id=0c59b4bb83ec68cf498f6ebaa5d3ee806c03ed32

Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
Date:      Fri Feb 22 13:43:12 2013 -0600

doc: Use More Readable Names for Generated Nodes

Per a discussion with the GNU Texinfo maintainer Patrice Dumas,
change to generating HTML files per a standard for stable URL
names and easier cross manual referencing.

http://lists.gnu.org/archive/html/help-texinfo/2013-02/msg00002.html

---

 doc/main.am    |    6 +++++-
 doc/project.am |    4 ++--
 2 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/main.am b/doc/main.am
index c19f7e6..13c58a3 100644
--- a/doc/main.am
+++ b/doc/main.am
@@ -2,8 +2,12 @@ if USE_HTML
 html_projectdir = $(htmldir)/$(PROJECT)
 endif
 
+# The arguments are carefully selected to make the output of texi2html
+# and texi2any generate into the same directory, using the same naming
+# patterns. This is intended to make the dependency tracking and install
+# file naming consistent.
 TEXI2HTML_ARGS=\
--D use-html --split node \
+-D use-html --split node --node-files \
 -o ./ \
 --top-file index.html \
 --init-file=$(top_builddir)/texi2html_init \
diff --git a/doc/project.am b/doc/project.am
index 6a8778b..6233948 100644
--- a/doc/project.am
+++ b/doc/project.am
@@ -51,14 +51,14 @@ html_project_DATA += *.html
 >>>>>>> bdf959d... doc/project.am: Fix whitespace at EOL
 
 if USE_TEXI2HTML
-index.html $(PROJECT)*.html: $(PROJECT).texi $($(PROJECT)_TEXINFOS)
+index.html *.html: $(PROJECT).texi $($(PROJECT)_TEXINFOS)
 	rm -rf $(PROJECT).html
 	$(TEXI2HTML) $(TEXI2HTML_ARGS) --menu $< $<
 	-rm -rf $(PROJECT)
 
 MOSTLYCLEANFILES += $(PROJECT)*.html 
 
-html_project_DATA += index.html $(PROJECT)*.html
+html_project_DATA += *.html
 endif # USE_TEXI2HTML
 
 if USE_TEXI2ANY




More information about the vc mailing list