Message-ID: <20191230121807.3a1f5f38@lwn.net>
Date:   Mon, 30 Dec 2019 12:18:07 -0700
From:   Jonathan Corbet <corbet@....net>
To:     "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
Cc:     mchehab+samsung@...nel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, skhan@...uxfoundation.org,
        linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [PATCH v2 2/8] Documentation: nfsroot.txt: convert to ReST

On Mon, 30 Dec 2019 01:55:56 -0300
"Daniel W. S. Almeida" <dwlsalmeida@...il.com> wrote:

> From: "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
> 
> Convert nfsroot.txt to RST and move it to admin-guide. Content remains
> mostly the same.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@...il.com>

This one, too, is almost there, but ...

>  Documentation/admin-guide/nfs/index.rst       |   1 +
>  .../nfs/nfsroot.rst}                          | 140 ++++++++++--------
>  2 files changed, 76 insertions(+), 65 deletions(-)
>  rename Documentation/{filesystems/nfs/nfsroot.txt => admin-guide/nfs/nfsroot.rst} (83%)
> 
> diff --git a/Documentation/admin-guide/nfs/index.rst b/Documentation/admin-guide/nfs/index.rst
> index f5c0180f4e5e..c2b87e9f0fed 100644
> --- a/Documentation/admin-guide/nfs/index.rst
> +++ b/Documentation/admin-guide/nfs/index.rst
> @@ -6,4 +6,5 @@ NFS
>      :maxdepth: 1
>  
>      nfs-client
> +    nfsroot
>  
> diff --git a/Documentation/filesystems/nfs/nfsroot.txt b/Documentation/admin-guide/nfs/nfsroot.rst
> similarity index 83%
> rename from Documentation/filesystems/nfs/nfsroot.txt
> rename to Documentation/admin-guide/nfs/nfsroot.rst
> index ae4332464560..85d834ad3d03 100644
> --- a/Documentation/filesystems/nfs/nfsroot.txt
> +++ b/Documentation/admin-guide/nfs/nfsroot.rst
> @@ -1,18 +1,24 @@
> +===============================================
>  Mounting the root filesystem via NFS (nfsroot)
>  ===============================================
>  
> -Written 1996 by Gero Kuhlmann <gero@...inix.han.de>
> -Updated 1997 by Martin Mares <mj@...ey.karlin.mff.cuni.cz>
> -Updated 2006 by Nico Schottelius <nico-kernel-nfsroot@...ottelius.org>
> -Updated 2006 by Horms <horms@...ge.net.au>
> -Updated 2018 by Chris Novakovic <chris@...isn.me.uk>
> +:Authors:
> +	Written 1996 by Gero Kuhlmann <gero@...inix.han.de>
> +
> +	Updated 1997 by Martin Mares <mj@...ey.karlin.mff.cuni.cz>
> +
> +	Updated 2006 by Nico Schottelius <nico-kernel-nfsroot@...ottelius.org>
> +
> +	Updated 2006 by Horms <horms@...ge.net.au>
> +
> +	Updated 2018 by Chris Novakovic <chris@...isn.me.uk>
>  
>  
>  
>  In order to use a diskless system, such as an X-terminal or printer server
>  for example, it is necessary for the root filesystem to be present on a
> -non-disk device. This may be an initramfs (see Documentation/filesystems/
> -ramfs-rootfs-initramfs.txt), a ramdisk (see Documentation/admin-guide/initrd.rst) or a
> +non-disk device. This may be an initramfs (see Documentation/filesystems/ramfs-rootfs-initramfs.txt`),

It's best in general to avoid refilling paragraphs so as to make it clear
what is being changed.  But we would also like to avoid creating such long
lines.  Perhaps an add-on patch refilling things would satisfy both
criteria here.

Also, there seems to be a stray backtick (`) in there.

> +a ramdisk (see Documentation/admin-guide/initrd.rst) or a
>  filesystem mounted via NFS. The following text describes on how to use NFS
>  for the root filesystem. For the rest of this text 'client' means the
>  diskless system, and 'server' means the NFS server.
> @@ -20,8 +26,8 @@ diskless system, and 'server' means the NFS server.
>  
>  
>  
> -1.) Enabling nfsroot capabilities
> -    -----------------------------
> +Enabling nfsroot capabilities
> +=============================
>  
>  In order to use nfsroot, NFS client support needs to be selected as
>  built-in during configuration. Once this has been selected, the nfsroot
> @@ -34,8 +40,8 @@ DHCP, BOOTP and RARP is safe.
>  
>  
>  
> -2.) Kernel command line
> -    -------------------
> +Kernel command line
> +===================
>  
>  When the kernel has been loaded by a boot loader (see below) it needs to be
>  told what root fs device to use. And in the case of nfsroot, where to find
> @@ -44,19 +50,17 @@ This can be established using the following kernel command line parameters:
>  
>  
>  root=/dev/nfs
> -
>    This is necessary to enable the pseudo-NFS-device. Note that it's not a
>    real device but just a synonym to tell the kernel to use NFS instead of
>    a real device.
>  
>  
>  nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
> -
>    If the `nfsroot' parameter is NOT given on the command line,
> -  the default "/tftpboot/%s" will be used.
> +  the default ``"/tftpboot/%s"`` will be used.
>  
>    <server-ip>	Specifies the IP address of the NFS server.
> -		The default address is determined by the `ip' parameter
> +		The default address is determined by the ip parameter
>  		(see below). This parameter allows the use of different
>  		servers for IP autoconfiguration and NFS.
>  
> @@ -67,6 +71,9 @@ nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
>  
>    <nfs-options>	Standard NFS options. All options are separated by commas.
>  		The following defaults are used:
> +
> +		::
> +

Please don't use the standalone "::" like that.  Just say "used::"

[...]

> -3.) Boot Loader
> -    ----------
> +Boot Loader
> +===========
>  
>  To get the kernel into memory different approaches can be used.
>  They depend on various facilities being available:
>  
>  
> -3.1)  Booting from a floppy using syslinux
> +#. Booting from a floppy using syslinux

Here, too, I wouldn't use "#".  This is essentially an unordered list, so
basic bullets should be fine.

Thanks,

jon

Powered by blists - more mailing lists