Re: [PATCH 06/17] CodingStyle.rst: use the proper tag for verbatim font

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Em Tue, 13 Sep 2016 19:45:23 +0200
Jean Delvare <jdelvare@xxxxxxx> escreveu:

> Hi Mauro,
> 
> On Mon, 12 Sep 2016 11:47:57 -0300, Mauro Carvalho Chehab wrote:
> > Instead of using "foo", use ``foo`` for the names that are
> > literal.  
> 
> Because...?

Because it is an usual typographic convention to use monospaced
fonts for functions and language commands on documents.

On Sphinx/ReST, ``foo`` means that foo will be displayed using a
monospaced font.

Regards,
Mauro.

> 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> > ---
> >  Documentation/kernel-development/CodingStyle.rst | 98 ++++++++++++------------
> >  1 file changed, 49 insertions(+), 49 deletions(-)
> > 
> > diff --git a/Documentation/kernel-development/CodingStyle.rst b/Documentation/kernel-development/CodingStyle.rst
> > index 3bc022b43ed8..4b2ba1008b11 100644
> > --- a/Documentation/kernel-development/CodingStyle.rst
> > +++ b/Documentation/kernel-development/CodingStyle.rst
> > @@ -38,8 +38,8 @@ benefit of warning you when you're nesting your functions too deep.
> >  Heed that warning.
> >  
> >  The preferred way to ease multiple indentation levels in a switch statement is
> > -to align the "switch" and its subordinate "case" labels in the same column
> > -instead of "double-indenting" the "case" labels.  E.g.:
> > +to align the ``switch`` and its subordinate ``case`` labels in the same column
> > +instead of ``double-indenting`` the ``case`` labels.  E.g.:
> >  
> >  .. code-block:: c
> >  (...)  
> 



Thanks,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux