[FFmpeg-devel] [PATCH 5/5] doc: Escape all backslashes needed to be escaped

[Stefano Sabatini]

On date Sunday 2015-03-22 20:47:20 -0700, Timothy Gu encoded:
> No, I do not want to do this, but a user requested it…
> 
> I think it is time for us to switch to a better documentation format.
> 
> Fixes #3867.
> ---
>  doc/developer.texi |  4 ++--
>  doc/encoders.texi  |  4 ++--
>  doc/faq.texi       |  8 ++++----
>  doc/ffmpeg.texi    |  4 ++--
>  doc/filters.texi   | 60 +++++++++++++++++++++++++++---------------------------
>  doc/indevs.texi    |  2 +-
>  doc/metadata.texi  |  6 +++---
>  doc/muxers.texi    | 38 +++++++++++++++++-----------------
>  doc/protocols.texi |  2 +-
>  doc/utils.texi     |  8 ++++----
>  10 files changed, 68 insertions(+), 68 deletions(-)

>From texinfo docs:

14.1.4 Inserting '\' with '@backslashchar{}'
--------------------------------------------

Ordinarily, a backslash '\' is a normal character in Texinfo that can be
simply typed in your input where you need it.  The result is to typeset
the backslash from the typewriter font.

  However, Texinfo uses the backslash as a special character in one
restricted context: to delimit formal arguments in the bodies of
user-defined macros (*note Defining Macros::).

  Due to the vagaries of macro argument parsing, it is more reliable to
pass an alphabetic command that produces a backslash instead of using a
literal \.  Hence '@backslashchar{}'.  Here is an example macro call:

     @mymac{One argument at backslashchar{} with a backslash}

  Texinfo documents may also use \ as a command character inside '@math'
(*note Inserting Math::).  In this case, '@\' or '\backslash' produces a
"math" backslash (from the math symbol font), while '@backslashchar{}'
produces a typewriter backslash as usual.

  Although '@backslashchar{}' can be used nearly anywhere, there is no
need for it except in these unusual cases.

...

So I'm not sure there is this requirement, especially if we're using \
within @example. 

[...]
-- 
FFmpeg = Free & Frightening Meaningful Puritan Exciting Geek