Re: [PATCH v2 3/8] Documentation: nfs-rdma: convert to ReST

From: Jonathan Corbet <corbet@lwn.net>
To: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
Cc: mchehab+samsung@kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH v2 3/8] Documentation: nfs-rdma: convert to ReST
Date: Mon, 30 Dec 2019 12:28:41 -0700	[thread overview]
Message-ID: <20191230122841.3a10db96@lwn.net> (raw)
In-Reply-To: <dd45de2519a3cc1fc07b6b29db77d6be113b0983.1577681164.git.dwlsalmeida@gmail.com>

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

> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Convert nfs-rdma to ReST and move it to admin-guide. Content
> remais mostly untouched.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

With this one, my main concern is that this document looks *way* out of
date, to the point that I wonder whether it is still useful or not.  It
would be good to find somebody who knows about this stuff to figure that
out.  Consider:

> +The NFS/RDMA client was first included in Linux 2.6.24. The NFS/RDMA server
> +was first included in the following release, Linux 2.6.25.

That was a while ago at this point.

> +Getting Help
> +============
> +
> +If you get stuck, you can ask questions on the
> +nfs-rdma-devel@lists.sourceforge.net mailing list.

What are the chances that this list still works and has relevant people to
it?  It might be worth sending a copy of this patch there and seeing what
results... 

> +- Install a Linux distribution and tools
> +
> +  The first kernel release to contain both the NFS/RDMA client and server was
> +  Linux 2.6.25  Therefore, a distribution compatible with this and subsequent
> +  Linux kernel release should be installed.

Hmmm..where might I find such a distribution...? :)

> +  The procedures described in this document have been tested with
> +  distributions from Red Hat's Fedora Project (http://fedora.redhat.com/).
> +
> +- Install nfs-utils-1.1.2 or greater on the client

I have nfs-utils 2.4.2 here.  So probably nobody needs to do this
installation at this point.

> +  Download the latest package from: http://www.kernel.org/pub/linux/utils/nfs

This directory, amusingly, has nothing after 1.0.7, so this advice is
actively wrong.

I could go on, but I think you get the point.  At a bare minimum we should
put a big warning at the top saying that this document is obsolete.  I
should create a standard warning, I guess; for now anything that gets the
point across should do.

Thanks,

jon