Subject: Re: linux-next: build warning after merge of the nfs-anna tree

From: Mike Snitzer <[email-masked]>
Date: Tue, 24 Sep 2024 13:08:50 -0400

On Tue, Sep 24, 2024 at 02:46:26PM +1000, Stephen Rothwell wrote:
> Hi all,
> 
> After merging the nfs-anna tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> Documentation/filesystems/nfs/localio.rst:43: ERROR: Unexpected indentation.
> Documentation/filesystems/nfs/localio.rst:56: ERROR: Unexpected indentation.
> Documentation/filesystems/nfs/localio.rst:179: WARNING: Inline emphasis start-string without end-string.
> Documentation/filesystems/nfs/localio.rst:190: WARNING: Definition list ends without a blank line; unexpected unindent.
> Documentation/filesystems/nfs/localio.rst:191: WARNING: Definition list ends without a blank line; unexpected unindent.
> Documentation/filesystems/nfs/localio.rst: WARNING: document isn't included in any toctree
> 
> Introduced by commit
> 
>   92945bd81ca4 ("nfs: add Documentation/filesystems/nfs/localio.rst")

Sorry for the trouble.

Anna, the following fixes all errors and warnings for me, please feel
free to fold this into the initial localio.rst commit Stephen
referenced, thanks:

diff --git a/Documentation/filesystems/nfs/index.rst b/Documentation/filesystems/nfs/index.rst
index 8536134f31fd..9298b47518d9 100644
--- a/Documentation/filesystems/nfs/index.rst
+++ b/Documentation/filesystems/nfs/index.rst
@@ -14,3 +14,4 @@ NFS
    nfs41-server
    knfsd-stats
    reexport
+   localio
diff --git a/Documentation/filesystems/nfs/localio.rst b/Documentation/filesystems/nfs/localio.rst
index 3c9bc370079b..5502c25021a0 100644
--- a/Documentation/filesystems/nfs/localio.rst
+++ b/Documentation/filesystems/nfs/localio.rst
@@ -40,12 +40,14 @@ using XDR and RPC for reads, writes and commits can be extreme, e.g.:
 
 fio for 20 secs with directio, qd of 8, 16 libaio threads:
 - With LOCALIO:
+
   4K read:    IOPS=979k,  BW=3825MiB/s (4011MB/s)(74.7GiB/20002msec)
   4K write:   IOPS=165k,  BW=646MiB/s  (678MB/s)(12.6GiB/20002msec)
   128K read:  IOPS=402k,  BW=49.1GiB/s (52.7GB/s)(982GiB/20002msec)
   128K write: IOPS=11.5k, BW=1433MiB/s (1503MB/s)(28.0GiB/20004msec)
 
 - Without LOCALIO:
+
   4K read:    IOPS=79.2k, BW=309MiB/s  (324MB/s)(6188MiB/20003msec)
   4K write:   IOPS=59.8k, BW=234MiB/s  (245MB/s)(4671MiB/20002msec)
   128K read:  IOPS=33.9k, BW=4234MiB/s (4440MB/s)(82.7GiB/20004msec)
@@ -53,12 +55,14 @@ fio for 20 secs with directio, qd of 8, 16 libaio threads:
 
 fio for 20 secs with directio, qd of 8, 1 libaio thread:
 - With LOCALIO:
+
   4K read:    IOPS=230k,  BW=898MiB/s  (941MB/s)(17.5GiB/20001msec)
   4K write:   IOPS=22.6k, BW=88.3MiB/s (92.6MB/s)(1766MiB/20001msec)
   128K read:  IOPS=38.8k, BW=4855MiB/s (5091MB/s)(94.8GiB/20001msec)
   128K write: IOPS=11.4k, BW=1428MiB/s (1497MB/s)(27.9GiB/20001msec)
 
 - Without LOCALIO:
+
   4K read:    IOPS=77.1k, BW=301MiB/s  (316MB/s)(6022MiB/20001msec)
   4K write:   IOPS=32.8k, BW=128MiB/s  (135MB/s)(2566MiB/20001msec)
   128K read:  IOPS=24.4k, BW=3050MiB/s (3198MB/s)(59.6GiB/20001msec)
@@ -85,19 +89,21 @@ Linux Kernel Organization       400122  nfslocalio
 
 The LOCALIO protocol spec in rpcgen syntax is:
 
-/* raw RFC 9562 UUID */
-#define UUID_SIZE 16
-typedef u8 uuid_t<UUID_SIZE>;
+::
 
-program NFS_LOCALIO_PROGRAM {
-    version LOCALIO_V1 {
-        void
-            NULL(void) = 0;
+  /* raw RFC 9562 UUID */
+  #define UUID_SIZE 16
+  typedef u8 uuid_t<UUID_SIZE>;
 
-        void
-            UUID_IS_LOCAL(uuid_t) = 1;
-    } = 1;
-} = 400122;
+  program NFS_LOCALIO_PROGRAM {
+      version LOCALIO_V1 {
+          void
+              NULL(void) = 0;
+
+          void
+              UUID_IS_LOCAL(uuid_t) = 1;
+      } = 1;
+  } = 400122;
 
 LOCALIO uses the same transport connection as NFS traffic. As such,
 LOCALIO is not registered with rpcbind.