Documentation/technical: avoid stray backslash in parse-options API docs
authorJonathan Nieder <jrnieder@gmail.com>
Fri, 20 Aug 2010 10:32:36 +0000 (05:32 -0500)
committerJunio C Hamano <gitster@pobox.com>
Fri, 20 Aug 2010 21:16:22 +0000 (14:16 -0700)
commit6dcca4d0ea4fe9ee09c939eaa0898f5895e5100a
tree998a5e2764820ff6db90a24ce500cb90d1223b27
parent12378c0aa8d06cb0e965935ca6d393a9b66b095a
Documentation/technical: avoid stray backslash in parse-options API docs

Due to some unpleasant interaction between the `quote', 'italics',
and `monospace` rules, a certain paragraph ends up rendered like so:

‘short` is a character for the short option
  (e.g. <tt>'e\’</tt> for <tt>-e</tt>, use <tt>0</tt> to omit),

Use the {apostrophe} to avoid this.

While at it, escape "->" strings: they are meant as a literal
two-character C operator, not a right-pointing arrow.

Reported-by: Frédéric Brière <fbriere@fbriere.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-parse-options.txt