]> git.baikalelectronics.ru Git - kernel.git/commit
Documentation/CodingStyle: use the proper tag for verbatim font
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 19 Sep 2016 11:07:45 +0000 (08:07 -0300)
committerJonathan Corbet <corbet@lwn.net>
Wed, 21 Sep 2016 00:36:53 +0000 (18:36 -0600)
commitc57b467b0c3741c525138163a7e7a752ca7ad421
tree434723e6654e479f03ae025fdd74557c1afc8bb0
parentc4a0c5dca642dc589910937dcdf8576c06b95140
Documentation/CodingStyle: use the proper tag for verbatim font

On Sphinx/ReST notation, ``foo`` means that foo will be will be
marked as inline literal, effectively making it to be presented
as a monospaced font.

As we want this document to be parsed by Sphinx, instead of using
"foo", use ``foo`` for the names that are literal, because it is an
usual typographic convention to use monospaced fonts for functions
and language commands on documents, and we're following such
convention on the other ReST books.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/CodingStyle