Re: [PATCH 05/17] README: convert it to ReST markup

[Diego Viola]

On Tue, Oct 4, 2016 at 4:42 PM, Diego Viola  wrote:
> On Wed, Sep 21, 2016 at 4:09 PM, Mauro Carvalho Chehab
>  wrote:
>> Adjust the readme file for it to use the ReST markup:
>>
>> - add chapter/section markups;
>> - use ``foo`` for commands;
>> - use :: for verbatim and script blocks;
>> - replace unsupported markup _foo_ by **foo**;
>> - add cross-references to other ReST files;
>> - use lower case on the section titles, to match other ReST files.
>>
>> Signed-off-by: Mauro Carvalho Chehab 
>> ---
>>  README | 105 
>> -
>>  1 file changed, 58 insertions(+), 47 deletions(-)
>>
>> diff --git a/README b/README
>> index 09f34f78f2bb..3335b3b2973a 100644
>> --- a/README
>> +++ b/README
>> @@ -1,10 +1,12 @@
>> -Linux kernel release 4.x 
>> +Linux kernel release 4.x 
>> +=
>>
>>  These are the release notes for Linux version 4.  Read them carefully,
>>  as they tell you what this is all about, explain how to install the
>>  kernel, and what to do if something goes wrong.
>>
>> -WHAT IS LINUX?
>> +What is Linux?
>> +--
>>
>>Linux is a clone of the operating system Unix, written from scratch by
>>Linus Torvalds with assistance from a loosely-knit team of hackers across
>> @@ -18,7 +20,8 @@ WHAT IS LINUX?
>>It is distributed under the GNU General Public License - see the
>>accompanying COPYING file for more details.
>>
>> -ON WHAT HARDWARE DOES IT RUN?
>> +On what hardware does it run?
>> +-
>>
>>Although originally developed first for 32-bit x86-based PCs (386 or 
>> higher),
>>today Linux also runs on (at least) the Compaq Alpha AXP, Sun SPARC and
>> @@ -34,7 +37,8 @@ ON WHAT HARDWARE DOES IT RUN?
>>Linux has also been ported to itself. You can now run the kernel as a
>>userspace application - this is called UserMode Linux (UML).
>>
>> -DOCUMENTATION:
>> +Documentation
>> +-
>>
>>   - There is a lot of documentation available both in electronic form on
>> the Internet and in books, both Linux-specific and pertaining to
>> @@ -53,14 +57,15 @@ DOCUMENTATION:
>>   - The Documentation/DocBook/ subdirectory contains several guides for
>> kernel developers and users.  These guides can be rendered in a
>> number of formats:  PostScript (.ps), PDF, HTML, & man-pages, among 
>> others.
>> -   After installation, "make psdocs", "make pdfdocs", "make htmldocs",
>> -   or "make mandocs" will render the documentation in the requested format.
>> +   After installation, ``make psdocs``, ``make pdfdocs``, ``make htmldocs``,
>> +   or ``make mandocs`` will render the documentation in the requested 
>> format.
>>
>> -INSTALLING the kernel source:
>> +Installing the kernel source
>> +
>>
>>   - If you install the full sources, put the kernel tarball in a
>> directory where you have permissions (e.g. your home directory) and
>> -   unpack it:
>> +   unpack it::
>>
>>   xz -cd linux-4.X.tar.xz | tar xvf -
>>
>> @@ -74,12 +79,12 @@ INSTALLING the kernel source:
>>   - You can also upgrade between 4.x releases by patching.  Patches are
>> distributed in the xz format.  To install by patching, get all the
>> newer patch files, enter the top level directory of the kernel source
>> -   (linux-4.X) and execute:
>> +   (linux-4.X) and execute::
>>
>>   xz -cd ../patch-4.x.xz | patch -p1
>>
>> Replace "x" for all versions bigger than the version "X" of your current
>> -   source tree, _in_order_, and you should be ok.  You may want to remove
>> +   source tree, **in_order**, and you should be ok.  You may want to remove
>> the backup files (some-file-name~ or some-file-name.orig), and make sure
>> that there are no failed patches (some-file-name# or some-file-name.rej).
>> If there are, either you or I have made a mistake.
>> @@ -90,12 +95,12 @@ INSTALLING the kernel source:
>> and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1
>> and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
>> want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
>> -   patch -R) _before_ applying the 4.0.3 patch. You can read more on this in
>> -   Documentation/applying-patches.txt
>> +   patch -R) **before** applying the 4.0.3 patch. You can read more on this 
>> in
>> +   :ref:`Documentation/applying-patches.txt `.
>>
>> Alternatively, the script patch-kernel can be used to automate this
>> process.  It determines the current kernel version and applies any
>> -   patches found.
>> +   patches found::
>>
>>   linux/scripts/patch-kernel linux
>>
>> @@ -103,55 +108,58 @@ INSTALLING the kernel source:
>> kernel source.  Patches are applied from the current directory, but
>> an alternative directory can be specified as the second argument.
>>
>> - - Make sure you

Re: [PATCH 05/17] README: convert it to ReST markup

[Diego Viola]

On Wed, Sep 21, 2016 at 4:09 PM, Mauro Carvalho Chehab
 wrote:
> Adjust the readme file for it to use the ReST markup:
>
> - add chapter/section markups;
> - use ``foo`` for commands;
> - use :: for verbatim and script blocks;
> - replace unsupported markup _foo_ by **foo**;
> - add cross-references to other ReST files;
> - use lower case on the section titles, to match other ReST files.
>
> Signed-off-by: Mauro Carvalho Chehab 
> ---
>  README | 105 
> -
>  1 file changed, 58 insertions(+), 47 deletions(-)
>
> diff --git a/README b/README
> index 09f34f78f2bb..3335b3b2973a 100644
> --- a/README
> +++ b/README
> @@ -1,10 +1,12 @@
> -Linux kernel release 4.x 
> +Linux kernel release 4.x 
> +=
>
>  These are the release notes for Linux version 4.  Read them carefully,
>  as they tell you what this is all about, explain how to install the
>  kernel, and what to do if something goes wrong.
>
> -WHAT IS LINUX?
> +What is Linux?
> +--
>
>Linux is a clone of the operating system Unix, written from scratch by
>Linus Torvalds with assistance from a loosely-knit team of hackers across
> @@ -18,7 +20,8 @@ WHAT IS LINUX?
>It is distributed under the GNU General Public License - see the
>accompanying COPYING file for more details.
>
> -ON WHAT HARDWARE DOES IT RUN?
> +On what hardware does it run?
> +-
>
>Although originally developed first for 32-bit x86-based PCs (386 or 
> higher),
>today Linux also runs on (at least) the Compaq Alpha AXP, Sun SPARC and
> @@ -34,7 +37,8 @@ ON WHAT HARDWARE DOES IT RUN?
>Linux has also been ported to itself. You can now run the kernel as a
>userspace application - this is called UserMode Linux (UML).
>
> -DOCUMENTATION:
> +Documentation
> +-
>
>   - There is a lot of documentation available both in electronic form on
> the Internet and in books, both Linux-specific and pertaining to
> @@ -53,14 +57,15 @@ DOCUMENTATION:
>   - The Documentation/DocBook/ subdirectory contains several guides for
> kernel developers and users.  These guides can be rendered in a
> number of formats:  PostScript (.ps), PDF, HTML, & man-pages, among 
> others.
> -   After installation, "make psdocs", "make pdfdocs", "make htmldocs",
> -   or "make mandocs" will render the documentation in the requested format.
> +   After installation, ``make psdocs``, ``make pdfdocs``, ``make htmldocs``,
> +   or ``make mandocs`` will render the documentation in the requested format.
>
> -INSTALLING the kernel source:
> +Installing the kernel source
> +
>
>   - If you install the full sources, put the kernel tarball in a
> directory where you have permissions (e.g. your home directory) and
> -   unpack it:
> +   unpack it::
>
>   xz -cd linux-4.X.tar.xz | tar xvf -
>
> @@ -74,12 +79,12 @@ INSTALLING the kernel source:
>   - You can also upgrade between 4.x releases by patching.  Patches are
> distributed in the xz format.  To install by patching, get all the
> newer patch files, enter the top level directory of the kernel source
> -   (linux-4.X) and execute:
> +   (linux-4.X) and execute::
>
>   xz -cd ../patch-4.x.xz | patch -p1
>
> Replace "x" for all versions bigger than the version "X" of your current
> -   source tree, _in_order_, and you should be ok.  You may want to remove
> +   source tree, **in_order**, and you should be ok.  You may want to remove
> the backup files (some-file-name~ or some-file-name.orig), and make sure
> that there are no failed patches (some-file-name# or some-file-name.rej).
> If there are, either you or I have made a mistake.
> @@ -90,12 +95,12 @@ INSTALLING the kernel source:
> and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1
> and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
> want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
> -   patch -R) _before_ applying the 4.0.3 patch. You can read more on this in
> -   Documentation/applying-patches.txt
> +   patch -R) **before** applying the 4.0.3 patch. You can read more on this 
> in
> +   :ref:`Documentation/applying-patches.txt `.
>
> Alternatively, the script patch-kernel can be used to automate this
> process.  It determines the current kernel version and applies any
> -   patches found.
> +   patches found::
>
>   linux/scripts/patch-kernel linux
>
> @@ -103,55 +108,58 @@ INSTALLING the kernel source:
> kernel source.  Patches are applied from the current directory, but
> an alternative directory can be specified as the second argument.
>
> - - Make sure you have no stale .o files and dependencies lying around:
> + - Make sure you have no stale .o files and dependencies lying around::
>
>   cd linux
>   make mrproper
>

[PATCH 05/17] README: convert it to ReST markup

[Mauro Carvalho Chehab]

Adjust the readme file for it to use the ReST markup:

- add chapter/section markups;
- use ``foo`` for commands;
- use :: for verbatim and script blocks;
- replace unsupported markup _foo_ by **foo**;
- add cross-references to other ReST files;
- use lower case on the section titles, to match other ReST files.

Signed-off-by: Mauro Carvalho Chehab 
---
 README | 105 -
 1 file changed, 58 insertions(+), 47 deletions(-)

diff --git a/README b/README
index 09f34f78f2bb..3335b3b2973a 100644
--- a/README
+++ b/README
@@ -1,10 +1,12 @@
-Linux kernel release 4.x 
+Linux kernel release 4.x 
+=
 
 These are the release notes for Linux version 4.  Read them carefully,
 as they tell you what this is all about, explain how to install the
 kernel, and what to do if something goes wrong.
 
-WHAT IS LINUX?
+What is Linux?
+--
 
   Linux is a clone of the operating system Unix, written from scratch by
   Linus Torvalds with assistance from a loosely-knit team of hackers across
@@ -18,7 +20,8 @@ WHAT IS LINUX?
   It is distributed under the GNU General Public License - see the
   accompanying COPYING file for more details.
 
-ON WHAT HARDWARE DOES IT RUN?
+On what hardware does it run?
+-
 
   Although originally developed first for 32-bit x86-based PCs (386 or higher),
   today Linux also runs on (at least) the Compaq Alpha AXP, Sun SPARC and
@@ -34,7 +37,8 @@ ON WHAT HARDWARE DOES IT RUN?
   Linux has also been ported to itself. You can now run the kernel as a
   userspace application - this is called UserMode Linux (UML).
 
-DOCUMENTATION:
+Documentation
+-
 
  - There is a lot of documentation available both in electronic form on
the Internet and in books, both Linux-specific and pertaining to
@@ -53,14 +57,15 @@ DOCUMENTATION:
  - The Documentation/DocBook/ subdirectory contains several guides for
kernel developers and users.  These guides can be rendered in a
number of formats:  PostScript (.ps), PDF, HTML, & man-pages, among others.
-   After installation, "make psdocs", "make pdfdocs", "make htmldocs",
-   or "make mandocs" will render the documentation in the requested format.
+   After installation, ``make psdocs``, ``make pdfdocs``, ``make htmldocs``,
+   or ``make mandocs`` will render the documentation in the requested format.
 
-INSTALLING the kernel source:
+Installing the kernel source
+
 
  - If you install the full sources, put the kernel tarball in a
directory where you have permissions (e.g. your home directory) and
-   unpack it:
+   unpack it::
 
  xz -cd linux-4.X.tar.xz | tar xvf -
 
@@ -74,12 +79,12 @@ INSTALLING the kernel source:
  - You can also upgrade between 4.x releases by patching.  Patches are
distributed in the xz format.  To install by patching, get all the
newer patch files, enter the top level directory of the kernel source
-   (linux-4.X) and execute:
+   (linux-4.X) and execute::
 
  xz -cd ../patch-4.x.xz | patch -p1
 
Replace "x" for all versions bigger than the version "X" of your current
-   source tree, _in_order_, and you should be ok.  You may want to remove
+   source tree, **in_order**, and you should be ok.  You may want to remove
the backup files (some-file-name~ or some-file-name.orig), and make sure
that there are no failed patches (some-file-name# or some-file-name.rej).
If there are, either you or I have made a mistake.
@@ -90,12 +95,12 @@ INSTALLING the kernel source:
and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1
and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
-   patch -R) _before_ applying the 4.0.3 patch. You can read more on this in
-   Documentation/applying-patches.txt
+   patch -R) **before** applying the 4.0.3 patch. You can read more on this in
+   :ref:`Documentation/applying-patches.txt `.
 
Alternatively, the script patch-kernel can be used to automate this
process.  It determines the current kernel version and applies any
-   patches found.
+   patches found::
 
  linux/scripts/patch-kernel linux
 
@@ -103,55 +108,58 @@ INSTALLING the kernel source:
kernel source.  Patches are applied from the current directory, but
an alternative directory can be specified as the second argument.
 
- - Make sure you have no stale .o files and dependencies lying around:
+ - Make sure you have no stale .o files and dependencies lying around::
 
  cd linux
  make mrproper
 
You should now have the sources correctly installed.
 
-SOFTWARE REQUIREMENTS
+Software requirements
+-
 
Compiling and running the 4.x kernels requires up-to-date
versions of various software packages.  Consult
-   Documentation/