A navigation sidebar for the HTML manuals

bfd/Makefile.in

@@ -1328,6 +1328,24 @@ REGEN_TEXI = \
 	)
 
 noinst_TEXINFOS = doc/bfdint.texi
+
+# The HTML manual is built with the navigation sidebar shared from
+# texinfo/toc-sidebar: toc-sidebar.init drives texi2any and writes the
+# contents tree (toc-sidebar-data.js) into the output directory; copy
+# the static assets in alongside it.  On a texi2any too old for the
+# sidebar the init file disables itself and the plain manual is built.
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+
+# ROCm branding.
+MANUAL_CSS = $(srcdir)/../rocm-theme.css
 all: $(BUILT_SOURCES) config.h
 	$(MAKE) $(AM_MAKEFLAGS) all-recursive
 
@@ -2531,9 +2549,12 @@ doc/bfdver.texi: $(srcdir)/Makefile.in
 	fi
 
 html-local: doc/bfd/index.html
-doc/bfd/index.html: doc/bfd.texi $(bfd_TEXINFOS) doc/$(am__dirstamp)
+doc/bfd/index.html: doc/bfd.texi $(bfd_TEXINFOS) doc/$(am__dirstamp) $(MANUAL_CSS)
 	$(AM_V_at)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -o doc/bfd $(srcdir)/doc/bfd.texi
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) doc/bfd
 
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.

bfd/doc/local.mk

@@ -142,9 +142,30 @@ DISTCLEANFILES += %D%/bfd.?? %D%/bfd.??? texput.log
 
 MAINTAINERCLEANFILES += $(DOCFILES)
 
+# The HTML manual is built with the navigation sidebar shared from
+# texinfo/toc-sidebar: toc-sidebar.init drives texi2any and writes the
+# contents tree (toc-sidebar-data.js) into the output directory; copy
+# the static assets in alongside it.  On a texi2any too old for the
+# sidebar the init file disables itself and the plain manual is built.
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+MANUAL_CSS =
+
+# ROCm branding.
+MANUAL_CSS += $(srcdir)/../rocm-theme.css
+
 html-local: %D%/bfd/index.html
-%D%/bfd/index.html: %D%/bfd.texi $(bfd_TEXINFOS) %D%/$(am__dirstamp)
+%D%/bfd/index.html: %D%/bfd.texi $(bfd_TEXINFOS) %D%/$(am__dirstamp) $(MANUAL_CSS)
 	$(AM_V_at)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -o %D%/bfd $(srcdir)/%D%/bfd.texi
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) %D%/bfd
 
 MAINTAINERCLEANFILES += %D%/bfd.info

binutils/Makefile.in

@@ -893,6 +893,21 @@ AM_MAKEINFOFLAGS = -I "$(srcdir)/doc" -I "$(top_srcdir)/../libiberty" \
 TEXI2DVI = texi2dvi -I "$(srcdir)/doc" -I "$(top_srcdir)/../libiberty" \
 		    -I "$(top_srcdir)/../bfd/doc" -I ../bfd/doc
 
+
+# Wire in the TOC navigation sidebar with the HTML manual.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+
+# ROCm branding.
+MANUAL_CSS = $(srcdir)/../rocm-theme.css
 all: $(BUILT_SOURCES) config.h
 	$(MAKE) $(AM_MAKEFLAGS) all-recursive
 
@@ -2171,10 +2186,17 @@ doc/$(DEMANGLER_NAME).1: doc/cxxfilt.man Makefile doc/$(am__dirstamp)
 	sed -e 's/cxxfilt/$(DEMANGLER_NAME)/' < $$man \
 		> doc/$(DEMANGLER_NAME).1
 
+# Unlike the ld and gas manuals, this rule passes no -o, so texi2any
+# derives the split output directory from binutils.texi's @setfilename
+# (binutils.info) and writes the manual to binutils_html; the copied
+# assets must land in that same directory.
 html-local: doc/binutils/index.html
-doc/binutils/index.html: doc/binutils.texi $(binutils_TEXINFOS)
+doc/binutils/index.html: doc/binutils.texi $(binutils_TEXINFOS) $(MANUAL_CSS)
 	$(AM_V_GEN)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -I$(srcdir) $(srcdir)/doc/binutils.texi
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) binutils_html
 
 # Maintenance
 

binutils/doc/local.mk

@@ -180,10 +180,32 @@ MAINTAINERCLEANFILES += $(man_MANS) %D%/binutils.info %D%/cxxfilt.man
 	sed -e 's/cxxfilt/$(DEMANGLER_NAME)/' < $$man \
 		> %D%/$(DEMANGLER_NAME).1
 
+# Wire in the TOC navigation sidebar with the HTML manual.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+MANUAL_CSS =
+
+# ROCm branding.
+MANUAL_CSS += $(srcdir)/../rocm-theme.css
+
+# Unlike the ld and gas manuals, this rule passes no -o, so texi2any
+# derives the split output directory from binutils.texi's @setfilename
+# (binutils.info) and writes the manual to binutils_html; the copied
+# assets must land in that same directory.
 html-local: %D%/binutils/index.html
-%D%/binutils/index.html: %D%/binutils.texi $(binutils_TEXINFOS)
+%D%/binutils/index.html: %D%/binutils.texi $(binutils_TEXINFOS) $(MANUAL_CSS)
 	$(AM_V_GEN)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -I$(srcdir) $(srcdir)/%D%/binutils.texi
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) binutils_html
 
 # Maintenance
 

gas/Makefile.in

@@ -1026,6 +1026,21 @@ CPU_DOCS = \
 
 # This one isn't ready for prime time yet.  Not even a little bit.
 noinst_TEXINFOS = doc/internals.texi
+
+# Wire in the TOC navigation sidebar with the HTML manual.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+
+# ROCm branding.
+MANUAL_CSS = $(srcdir)/../rocm-theme.css
 all: config.h
 	$(MAKE) $(AM_MAKEFLAGS) all-recursive
 
@@ -2272,9 +2287,12 @@ doc/as.1: $(srcdir)/doc/as.texi doc/asconfig.texi $(CPU_DOCS) doc/$(am__dirstamp
 	$(AM_V_at)rm -f doc/as.pod
 
 html-local: doc/as/index.html
-doc/as/index.html: doc/as.texi $(doc_as_TEXINFOS) doc/$(am__dirstamp)
+doc/as/index.html: doc/as.texi $(doc_as_TEXINFOS) doc/$(am__dirstamp) $(MANUAL_CSS)
 	$(AM_V_GEN)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -I$(srcdir)/doc -o doc/as $(srcdir)/doc/as.texi
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) doc/as
 
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.

gas/doc/local.mk

@@ -124,9 +124,27 @@ info-local: $(MANS)
 	        (rm -f $@.T$$$$ && exit 1)
 	$(AM_V_at)rm -f %D%/as.pod
 
+# Wire in the TOC navigation sidebar with the HTML manual.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+MANUAL_CSS =
+
+# ROCm branding.
+MANUAL_CSS += $(srcdir)/../rocm-theme.css
+
 html-local: %D%/as/index.html
-%D%/as/index.html: %D%/as.texi $(%C%_as_TEXINFOS) %D%/$(am__dirstamp)
+%D%/as/index.html: %D%/as.texi $(%C%_as_TEXINFOS) %D%/$(am__dirstamp) $(MANUAL_CSS)
 	$(AM_V_GEN)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -I$(srcdir)/%D% -o %D%/as $(srcdir)/%D%/as.texi
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) %D%/as
 
 MAINTAINERCLEANFILES += %D%/as.info

gdb/doc/Makefile.in

@@ -85,6 +85,12 @@ PACKAGE = @PACKAGE@
 PKGVERSION = @PKGVERSION@
 BUGURL_TEXI = @REPORT_BUGS_TEXI@
 
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+MANUAL_CSS =
+
 # Where is the source dir for the READLINE library doc?
 # Traditionally readline is in .. or .
 READLINE_DIR = ${gdbdir}/../readline/readline/doc
@@ -542,11 +548,24 @@ gdb.mm: $(GDB_DOC_FILES) links2roff
 
 # GDB MANUAL: HTML file
 
-gdb/index.html: ${GDB_DOC_FILES}
+# Wire in the TOC navigation sidebar with the HTML manual.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+TOC_SIDEBAR_INIT = $(TOC_SIDEBAR_DIR)/toc-sidebar.init
+
+# ROCm branding.
+MANUAL_CSS += $(srcdir)/../../rocm-theme.css
+
+gdb/index.html: ${GDB_DOC_FILES} $(TOC_SIDEBAR_INIT) $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS)
 	$(ECHO_GEN) $(MAKEHTML) $(MAKEHTMLFLAGS) \
+		--init-file=$(TOC_SIDEBAR_INIT) \
+		$(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 		-o gdb \
 		$(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) \
 		$(srcdir)/gdb.texinfo
+	$(SILENCE) cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) gdb/
 
 # ANNOTATE DOCUMENTATION: TeX dvi file
 annotate.dvi : $(ANNOTATE_DOC_FILES)

ld/Makefile.am

@@ -816,11 +816,29 @@ diststuff: info $(EXTRA_DIST)
 # ld.1 to support parallel build.
 info-recursive: ld.1
 
+# Wire in the TOC navigation sidebar with the HTML manual.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+MANUAL_CSS =
+
+# ROCm branding.
+MANUAL_CSS += $(srcdir)/../rocm-theme.css
+
 html-local: doc/ld/index.html
-doc/ld/index.html: ld.texi $(ld_TEXINFOS)
+doc/ld/index.html: ld.texi $(ld_TEXINFOS) $(MANUAL_CSS)
 	$(AM_V_at)$(MKDIR_P) doc
 	$(AM_V_GEN)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -I$(srcdir) $(srcdir)/ld.texi -o doc/ld
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) doc/ld
 
 DISTCLEANFILES = site.exp development.exp enablings.exp site.bak
 distclean-local:

ld/Makefile.in

@@ -1084,6 +1084,21 @@ CLEANFILES = dep.sed DEP DEPA DEP1 DEP2 spu_ovl.s spu_ovl.@OBJEXT@ spu_icache.s
 EXTRA_DIST = ldgram.c ldgram.h ldlex.c emultempl/spu_ovl.@OBJEXT@_c \
 	     emultempl/spu_icache.@OBJEXT@_c deffilep.c deffilep.h $(man_MANS)
 
+
+# Hook in the TOC navigation sidebar.
+#
+TOC_SIDEBAR_DIR = $(srcdir)/../texinfo/toc-sidebar
+TOC_SIDEBAR_ASSETS = $(TOC_SIDEBAR_DIR)/toc-sidebar.css \
+		     $(TOC_SIDEBAR_DIR)/toc-sidebar.js
+
+
+# List of extra stylesheets to brand the HTML manual.  Each stylesheet
+# is referenced with --css-ref and copied into the output directory.
+# It is empty by default and can be set on the make command line, so a
+# build can theme the manual without editing the sources.
+
+# ROCm branding.
+MANUAL_CSS = $(srcdir)/../rocm-theme.css
 DISTCLEANFILES = site.exp development.exp enablings.exp site.bak
 all: $(BUILT_SOURCES) config.h
 	$(MAKE) $(AM_MAKEFLAGS) all-recursive
@@ -2475,10 +2490,13 @@ diststuff: info $(EXTRA_DIST)
 info-recursive: ld.1
 
 html-local: doc/ld/index.html
-doc/ld/index.html: ld.texi $(ld_TEXINFOS)
+doc/ld/index.html: ld.texi $(ld_TEXINFOS) $(MANUAL_CSS)
 	$(AM_V_at)$(MKDIR_P) doc
 	$(AM_V_GEN)$(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
+	  --init-file=$(TOC_SIDEBAR_DIR)/toc-sidebar.init \
+	  $(foreach css,$(MANUAL_CSS),--css-ref=$(notdir $(css))) \
 	  --split=node -I$(srcdir) $(srcdir)/ld.texi -o doc/ld
+	$(AM_V_at)cp $(TOC_SIDEBAR_ASSETS) $(MANUAL_CSS) doc/ld
 distclean-local:
 	rm -rf ldscripts