From: John Hubbard <jhubbard@nvidia.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Jan Kara <jack@suse.cz>, David Sterba <dsterba@suse.com>,
<linux-doc@vger.kernel.org>, LKML <linux-kernel@vger.kernel.org>,
John Hubbard <jhubbard@nvidia.com>
Subject: [PATCH] Documentation: filesystems: better locations for sysfs-pci, sysfs-tagging
Date: Wed, 7 Oct 2020 16:31:51 -0700 [thread overview]
Message-ID: <20201007233151.490953-1-jhubbard@nvidia.com> (raw)
sysfs-pci and sysfs-tagging were mis-filed: their locations with
Documentation/ implied that they were related to file systems. Actually,
each topic is about a very specific *use* of sysfs, and sysfs *happens*
to be a (virtual) filesystem, so this is not really the right place.
It's jarring to be reading about filesystems in general and then come
across these specific details about PCI, and tagging...and then back to
general filesystems again.
Move sysfs-pci and sysfs-tagging to a location under the sysfs topic.
Signed-off-by: John Hubbard <jhubbard@nvidia.com>
---
Hi,
I'm not sure if the "toctree, maxdepth: 1" is the ideal way to do this,
but the output in the browser looks about right to me, anyway.
thanks,
John Hubbard
NVIDIA
Documentation/filesystems/index.rst | 2 --
Documentation/filesystems/sysfs.rst | 14 ++++++++++++++
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index 4c536e66dc4c..98f59a864242 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -34,8 +34,6 @@ algorithms work.
quota
seq_file
sharedsubtree
- sysfs-pci
- sysfs-tagging
automount-support
diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
index ab0f7795792b..39da2f5c235f 100644
--- a/Documentation/filesystems/sysfs.rst
+++ b/Documentation/filesystems/sysfs.rst
@@ -416,3 +416,17 @@ ABI between the kernel and user space. As for any ABI, it is important that
this ABI is stable and properly documented. All new sysfs attributes must be
documented in Documentation/ABI. See also Documentation/ABI/README for more
information.
+
+sysfs and PCI
+~~~~~~~~~~~~~
+.. toctree::
+ :maxdepth: 1
+
+ sysfs-pci
+
+sysfs and tagging
+~~~~~~~~~~~~~~~~~
+.. toctree::
+ :maxdepth: 1
+
+ sysfs-tagging
--
2.28.0
next reply other threads:[~2020-10-07 23:31 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-07 23:31 John Hubbard [this message]
2020-10-08 16:04 ` [PATCH] Documentation: filesystems: better locations for sysfs-pci, sysfs-tagging Jonathan Corbet
2020-10-08 19:28 ` John Hubbard
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=20201007233151.490953-1-jhubbard@nvidia.com \
--to=jhubbard@nvidia.com \
--cc=corbet@lwn.net \
--cc=dsterba@suse.com \
--cc=jack@suse.cz \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
/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