summaryrefslogtreecommitdiff
path: root/Documentation/sphinx
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2016-05-26 10:40:17 +0300
committerJani Nikula <jani.nikula@intel.com>2016-05-30 13:38:54 +0300
commit30ca7aaf279944da930b587b05d9b325ec7f821d (patch)
treeddcb1575c0df64f651a265c6613cc3554697fc12 /Documentation/sphinx
parent2e83ecb834ca923806fd58fab17d9f405767e1d9 (diff)
downloadlinux-30ca7aaf279944da930b587b05d9b325ec7f821d.tar.xz
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>
Diffstat (limited to 'Documentation/sphinx')
-rw-r--r--Documentation/sphinx/convert_template.sed10
-rw-r--r--Documentation/sphinx/post_convert.sed10
2 files changed, 14 insertions, 6 deletions
diff --git a/Documentation/sphinx/convert_template.sed b/Documentation/sphinx/convert_template.sed
index 0553eabeac79..c1503fcca4ec 100644
--- a/Documentation/sphinx/convert_template.sed
+++ b/Documentation/sphinx/convert_template.sed
@@ -2,12 +2,16 @@
# Pandoc doesn't grok <function> or <structname>, so convert them
# ahead of time.
#
-# Use "$bq" instead of "`" so that pandoc won't mess with it.
+# 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:$bq\1$bq%g
-s%<structname>\([^<]\+\)</structname>%:c:type:$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.
#
diff --git a/Documentation/sphinx/post_convert.sed b/Documentation/sphinx/post_convert.sed
index ce17049f6a8e..392770bac53b 100644
--- a/Documentation/sphinx/post_convert.sed
+++ b/Documentation/sphinx/post_convert.sed
@@ -1,9 +1,13 @@
#
-# pandoc thinks that both "_" needs to be escaped. Remove the extra
-# backslashes. Also put in proper backquotes now that pandoc won't quote
-# them.
+# 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.