Re: [PATCH 03/36] docs-rst: convert kernel-locking to ReST

From: Mauro Carvalho Chehab
Date: Sat May 13 2017 - 05:26:32 EST


Em Fri, 12 May 2017 18:57:13 +0200
Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:

> Am 12.05.2017 um 15:59 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:
>
> > Use pandoc to convert documentation to ReST by calling
> > Documentation/sphinx/tmplcvt script.
> >
> > - Manually adjust tables with got broken by conversion
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> > ---
> > Documentation/DocBook/Makefile | 1 -
> > Documentation/DocBook/kernel-locking.tmpl | 2151 -----------------------------
> > Documentation/kernel-hacking/hacking.rst | 811 +++++++++++
> > Documentation/kernel-hacking/index.rst | 814 +----------
> > Documentation/kernel-hacking/locking.rst | 1453 +++++++++++++++++++
> > 5 files changed, 2268 insertions(+), 2962 deletions(-)
> > delete mode 100644 Documentation/DocBook/kernel-locking.tmpl
> > create mode 100644 Documentation/kernel-hacking/hacking.rst
> > create mode 100644 Documentation/kernel-hacking/locking.rst
> >
> > ...
>
> > diff --git a/Documentation/kernel-hacking/index.rst b/Documentation/kernel-hacking/index.rst
> > index 1a456b60a7cf..b3d8fe56d310 100644
> > --- a/Documentation/kernel-hacking/index.rst
> > +++ b/Documentation/kernel-hacking/index.rst
> > @@ -1,811 +1,5 @@
> > -============================================
> > -Unreliable Guide To Hacking The Linux Kernel
> > -============================================
> > +.. toctree::
> > + :maxdepth: 2
>
> Every .rst file needs a title, otherwise <no title> is inserted,
> see breadcrumb at the top :
>
> https://mchehab.fedorapeople.org/kernel_docs/kernel-hacking/index.html

Thanks for review!

I'll fold it with the enclosed path.

diff --git a/Documentation/conf.py b/Documentation/conf.py
index bfa95c881956..0ce8001a50b6 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -352,7 +352,7 @@ latex_documents = [
'The kernel development community', 'manual'),
('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
'The kernel development community', 'manual'),
- ('kernel-hacking/index', 'kernel-hacking.tex', 'Unreliable Guide To Hacking The Linux Kernel',
+ ('kernel-hacking/index', 'kernel-hacking.tex', 'Kernel Hacking Guides',
'The kernel development community', 'manual'),
('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
'The kernel development community', 'manual'),
diff --git a/Documentation/kernel-hacking/conf.py b/Documentation/kernel-hacking/conf.py
index 4facca74a6f0..3d8acf0f33ad 100644
--- a/Documentation/kernel-hacking/conf.py
+++ b/Documentation/kernel-hacking/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8; mode: python -*-

-project = "Unreliable Guide To Hacking The Linux Kernel"
+project = "Kernel Hacking Guides"

tags.add("subproject")

diff --git a/Documentation/kernel-hacking/index.rst b/Documentation/kernel-hacking/index.rst
index b3d8fe56d310..fcb0eda3cca3 100644
--- a/Documentation/kernel-hacking/index.rst
+++ b/Documentation/kernel-hacking/index.rst
@@ -1,3 +1,7 @@
+=====================
+Kernel Hacking Guides
+=====================
+
.. toctree::
:maxdepth: 2

diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index 1a456b60a7cf..58831decd5ae 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -764,7 +764,7 @@ Some favorites from browsing the source. Feel free to add to this list.
#define PTR_ERR(ptr) ((long)(ptr))
#define IS_ERR(ptr) ((unsigned long)(ptr) > (unsigned long)(-1000))

-``arch/x86/include/asm/uaccess_32.h:``::
+``arch/x86/include/asm/uaccess_32.h``::

#define copy_to_user(to,from,n) \
(__builtin_constant_p(n) ? \
@@ -772,7 +772,7 @@ Some favorites from browsing the source. Feel free to add to this list.
__generic_copy_to_user((to),(from),(n)))


-``arch/sparc/kernel/head.S:``::
+``arch/sparc/kernel/head.S``::

/*
* Sun people can't spell worth damn. "compatability" indeed.
@@ -791,7 +791,7 @@ Some favorites from browsing the source. Feel free to add to this list.
.asciz "compatible"


-``arch/sparc/lib/checksum.S:``::
+``arch/sparc/lib/checksum.S``::

/* Sun, you just can't beat me, you just can't. Stop trying,
* give up. I'm serious, I am going to kick the living shit


Thanks,
Mauro