Commit eb81d930 authored by Borislav Petkov's avatar Borislav Petkov Committed by Linus Torvalds
Browse files

kernel-doc: generate main index page when building 'htmldocs' 



A patch for kernel-doc that enables the generation of a global, TOC-like
index.html page after building 'htmldocs'

Signed-off-by: default avatarBorislav Petkov <bbpetkov@yahoo.de>
Acked-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 198b7660

Documentation/DocBook/Makefile

+9 −1
Original line number Original line Diff line number Diff line
@@ -43,6 +43,7 @@ pdfdocs: $(PDF) 




HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))

HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))

htmldocs: $(HTML)

htmldocs: $(HTML)

	$(call build_main_index)





MAN := $(patsubst %.xml, %.9, $(BOOKS))

MAN := $(patsubst %.xml, %.9, $(BOOKS))

mandocs: $(MAN)

mandocs: $(MAN)
@@ -132,10 +133,17 @@ quiet_cmd_db2pdf = PDF $@ 
%.pdf : %.xml

%.pdf : %.xml

	$(call cmd,db2pdf)

	$(call cmd,db2pdf)







main_idx = Documentation/DocBook/index.html

build_main_index = rm -rf $(main_idx) && \

		   echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \

		   echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \

		   cat $(HTML) >> $(main_idx)



quiet_cmd_db2html = HTML   $@

quiet_cmd_db2html = HTML   $@

      cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \

      cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \

		echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \

		echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \

         Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@

        $(patsubst %.html,%,$(notdir $@))</a><p>' > $@





%.html:	%.xml

%.html:	%.xml

	@(which xmlto > /dev/null 2>&1) || \

	@(which xmlto > /dev/null 2>&1) || \

CRA Git | Maintained and supported by SUSTech CRA and CCSE