Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1640574

Re: [PATCH 01/36] docs-rst: convert kernel-hacking to ReST

Show all headers | View raw

Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab <mchehab@s-opensource.com>:

> Use pandoc to convert documentation to ReST by calling
> Documentation/sphinx/tmplcvt script.
> 
> - Manually adjusted to use ..note and ..warning
> - Minor fixes for it to be parsed without errors
> - Use **bold** for emphasis.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> ---
> Documentation/DocBook/Makefile            |    2 +-
> Documentation/DocBook/kernel-hacking.tmpl | 1312 -----------------------------
> Documentation/conf.py                     |    2 +
> Documentation/index.rst                   |    1 +
> Documentation/kernel-hacking/conf.py      |   10 +
> Documentation/kernel-hacking/index.rst    |  794 +++++++++++++++++
> 6 files changed, 808 insertions(+), 1313 deletions(-)
> delete mode 100644 Documentation/DocBook/kernel-hacking.tmpl
> create mode 100644 Documentation/kernel-hacking/conf.py
> create mode 100644 Documentation/kernel-hacking/index.rst
> 
> 
....

> +:c:func:`cpu_to_be32()`/:c:func:`be32_to_cpu()`/:c:func:`cpu_to_le32()`/:c:func:`le32_to_cpu()` ``include/asm/byteorder.h``
> +---------------------------------------------------------------------------------------------------------------------------
> +

Hi Mauro, just my bikeshedding:

what do you think, do we really need to refer functions in titles?
As far as I know, there is no use-case where we can get any benefit
from. So I recommend to write titles more simple, e.g.:

  cpu_to_be32()/be32_to_cpu()/cpu_to_le32()/le32_to_cpu() include/asm/byteorder.h

.. which is long enough ;)

-- Markus --

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

Re: [PATCH 01/36] docs-rst: convert kernel-hacking to ReST Markus Heiser <markus.heiser@darmarit.de> - 2017-05-12 18:40 +0200
  Re: [PATCH 01/36] docs-rst: convert kernel-hacking to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-13 12:10 +0200

csiph-web