tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Documentation/sphinx: nicer referencing of struct in docbook->rst conversion
Add "struct" in the label of the reference.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
+14
-6
+7
-3
Documentation/sphinx/convert_template.sed
+7
-3
Documentation/sphinx/convert_template.sed
···
2
2
# Pandoc doesn't grok <function> or <structname>, so convert them
3
3
# ahead of time.
4
4
#
5
-
# Use "$bq" instead of "`" so that pandoc won't mess with it.
5
+
# Use the following escapes to pass through pandoc:
6
+
# $bq = "`"
7
+
# $lt = "<"
8
+
# $gt = ">"
6
9
#
7
10
s%<function>\([^<(]\+\)()</function>%:c:func:$bq\1()$bq%g
8
11
s%<function>\([^<(]\+\)</function>%:c:func:$bq\1()$bq%g
9
-
s%<structname>struct *\([^<]\+\)</structname>%:c:type:$bq\1$bq%g
10
-
s%<structname>\([^<]\+\)</structname>%:c:type:$bq\1$bq%g
12
+
s%<structname>struct *\([^<]\+\)</structname>%:c:type:$bqstruct \1 $lt\1$gt$bq%g
13
+
s%struct <structname>\([^<]\+\)</structname>%:c:type:$bqstruct \1 $lt\1$gt$bq%g
14
+
s%<structname>\([^<]\+\)</structname>%:c:type:$bqstruct \1 $lt\1$gt$bq%g
11
15
#
12
16
# Wrap docproc directives in para and code blocks.
13
17
#
+7
-3
Documentation/sphinx/post_convert.sed
+7
-3
Documentation/sphinx/post_convert.sed
···
1
1
#
2
-
# pandoc thinks that both "_" needs to be escaped. Remove the extra
3
-
# backslashes. Also put in proper backquotes now that pandoc won't quote
4
-
# them.
2
+
# Unescape.
5
3
#
6
4
s/$bq/`/g
5
+
s/$lt/</g
6
+
s/$gt/>/g
7
+
#
8
+
# pandoc thinks that both "_" needs to be escaped. Remove the extra
9
+
# backslashes.
10
+
#
7
11
s/\\_/_/g
8
12
#
9
13
# Unwrap docproc directives.