Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 52b3f239 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

Docs: clean up some DocBook loose ends



There were a few bits and pieces left over from the now-disused DocBook
toolchain; git rid of them.

Reported-by: default avatarMarkus Heiser <markus.heiser@darmarit.de>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 61ca5fd1
Loading
Loading
Loading
Loading
+0 −1
Original line number Diff line number Diff line
@@ -118,7 +118,6 @@ defkeymap.c
devlist.h*
devicetable-offsets.h
dnotify_test
docproc
dslm
dtc
elf2ecoff
+0 −18
Original line number Diff line number Diff line
#
# Pandoc doesn't grok <function> or <structname>, so convert them
# ahead of time.
#
# Use the following escapes to pass through pandoc:
#	$bq = "`"
#	$lt = "<"
#	$gt = ">"
#
s%<function>\([^<(]\+\)()</function>%:c:func:$bq\1()$bq%g
s%<function>\([^<(]\+\)</function>%:c:func:$bq\1()$bq%g
s%<structname>struct *\([^<]\+\)</structname>%:c:type:$bqstruct \1 $lt\1$gt$bq%g
s%struct <structname>\([^<]\+\)</structname>%:c:type:$bqstruct \1 $lt\1$gt$bq%g
s%<structname>\([^<]\+\)</structname>%:c:type:$bqstruct \1 $lt\1$gt$bq%g
#
# Wrap docproc directives in para and code blocks.
#
s%^\(!.*\)$%<para><code>DOCPROC: \1</code></para>%
+0 −23
Original line number Diff line number Diff line
#
# Unescape.
#
s/$bq/`/g
s/$lt/</g
s/$gt/>/g
#
# pandoc thinks that both "_" needs to be escaped.  Remove the extra
# backslashes.
#
s/\\_/_/g
#
# Unwrap docproc directives.
#
s/^``DOCPROC: !E\(.*\)``$/.. kernel-doc:: \1\n   :export:/
s/^``DOCPROC: !I\(.*\)``$/.. kernel-doc:: \1\n   :internal:/
s/^``DOCPROC: !F\([^ ]*\) \(.*\)``$/.. kernel-doc:: \1\n   :functions: \2/
s/^``DOCPROC: !P\([^ ]*\) \(.*\)``$/.. kernel-doc:: \1\n   :doc: \2/
s/^``DOCPROC: \(!.*\)``$/.. WARNING: DOCPROC directive not supported: \1/
#
# Trim trailing whitespace.
#
s/[[:space:]]*$//
+1 −2
Original line number Diff line number Diff line
@@ -4135,8 +4135,7 @@ M: Jonathan Corbet <corbet@lwn.net>
L:	linux-doc@vger.kernel.org
S:	Maintained
F:	Documentation/
F:	scripts/docproc.c
F:	scripts/kernel-doc*
F:	scripts/kernel-doc
X:	Documentation/ABI/
X:	Documentation/devicetree/
X:	Documentation/acpi
+0 −1
Original line number Diff line number Diff line
@@ -1467,7 +1467,6 @@ $(help-board-dirs): help-%:
DOC_TARGETS := xmldocs sgmldocs psdocs latexdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs linkcheckdocs
PHONY += $(DOC_TARGETS)
$(DOC_TARGETS): scripts_basic FORCE
	$(Q)$(MAKE) $(build)=scripts build_docproc
	$(Q)$(MAKE) $(build)=Documentation $@

else # KBUILD_EXTMOD
Loading