public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jeff Layton <jlayton@kernel.org>
To: brauner@kernel.org
Cc: sfr@canb.auug.org.au, linux-fsdevel@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH] Documentation: clean up warnings for multigrain timestamp docs
Date: Thu,  1 Aug 2024 06:51:27 -0400	[thread overview]
Message-ID: <20240801105127.25048-1-jlayton@kernel.org> (raw)

Stephen Rothwell reported seeing a couple of warnings when building
htmldocs:

/home/jlayton/git/linux/Documentation/filesystems/multigrain-ts.rst:83: WARNING: duplicate label filesystems/multigrain-ts:multigrain timestamps, other instance in /home/jlayton/git/linux/Documentation/filesystems/multigrain-ts.rst
/home/jlayton/git/linux/Documentation/filesystems/multigrain-ts.rst: WARNING: document isn't included in any toctree

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Jeff Layton <jlayton@kernel.org>
---
 Documentation/filesystems/index.rst         | 1 +
 Documentation/filesystems/multigrain-ts.rst | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)

Christian,

It may be best to fold this patch into f9cb86069bad (Documentation: add a
new file documenting multigrain timestamps)

diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index e8e496d23e1d..44e9e77ffe0d 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -29,6 +29,7 @@ algorithms work.
    fiemap
    files
    locks
+   multigrain-ts
    mount_api
    quota
    seq_file
diff --git a/Documentation/filesystems/multigrain-ts.rst b/Documentation/filesystems/multigrain-ts.rst
index f58c14c53b0f..97877ab3d933 100644
--- a/Documentation/filesystems/multigrain-ts.rst
+++ b/Documentation/filesystems/multigrain-ts.rst
@@ -79,8 +79,8 @@ is no such guarantee, and the second file may appear to have been modified
 before, after or at the same time as the first, regardless of which one was
 submitted first.
 
-Multigrain Timestamps
-=====================
+Multigrain Timestamp Implementation
+===================================
 Multigrain timestamps are aimed at ensuring that changes to a single file are
 always recognizable, without violating the ordering guarantees when multiple
 different files are modified. This affects the mtime and the ctime, but the
-- 
2.45.2


             reply	other threads:[~2024-08-01 10:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-01 10:51 Jeff Layton [this message]
2024-08-01 13:42 ` [PATCH] Documentation: clean up warnings for multigrain timestamp docs Christian Brauner
2024-08-01 13:43 ` Christian Brauner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240801105127.25048-1-jlayton@kernel.org \
    --to=jlayton@kernel.org \
    --cc=brauner@kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox