docs/pandoc: Don't escape underscores in the middle of text
authorAndrew Cooper <andrew.cooper3@citrix.com>
Wed, 2 Jan 2019 10:26:45 +0000 (10:26 +0000)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Wed, 2 Jan 2019 17:50:36 +0000 (17:50 +0000)
commit5020c170e2c77c52632d1455e383ce09e39b529d
tree263c13018f8ff857993516ce857c6b2349aea04d
parente5268a3ce35be2d0e1b910ef8a6b0ad4de3c3a1a
docs/pandoc: Don't escape underscores in the middle of text

Pandoc deliberately (and contrary to markdown) doesn't treat underscores in
the middle of normal text as emphasis markers, as this is almost always the
unhelpful interpretation.

For text which is emphasised using _, an underscore in the middle is
interpreted, but the emphasis marker can be switched to * instead.

One problem case is where we use {} globbing with identifier names, as it
counts as a word break.  Therefore, we do need to retain the escaped
underscore immediately following a closing brace.

No change in content - only formatting.  This results in the text being easier
to read and grep.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
docs/features/feature-levelling.pandoc
docs/features/migration.pandoc
docs/features/sched_credit2.pandoc
docs/features/sched_rtds.pandoc
docs/specs/libxc-migration-stream.pandoc
docs/specs/libxl-migration-stream.pandoc