]> git.baikalelectronics.ru Git - kernel.git/commit
writing_musb_glue_layer.rst: Enrich its ReST representation
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 5 Apr 2017 13:23:01 +0000 (10:23 -0300)
committerJonathan Corbet <corbet@lwn.net>
Tue, 11 Apr 2017 20:38:32 +0000 (14:38 -0600)
commit4ffeb09b3899d8b5df728767ff5134301ad5284b
tree84bd4c8485d0ac88dddf20c213ae77599a8f9266
parent96177a129b3cd6fc2d2d5d58be0b2918432f4d14
writing_musb_glue_layer.rst: Enrich its ReST representation

This file is actually quite complex, and required several
manual handwork:

- add a title for the document;
- use the right tags for monospaced fonts;
- use c references where needed;
- adjust cross-reference to writing_usb_driver.rst
- hightlight cross-referenced lines.

With regards to C code snippet line highlights, the better would be
to use :linenos: for the C code snippets that are referenced by
the line number. However, at least with Sphinx 1.4.9, enabling
it cause the line number to be misaligned with the code,
making it even more confusing. So, instead, let's use
:emphasize-lines: tag to mark the lines that are referenced
at the text.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/driver-api/usb/writing_musb_glue_layer.rst