lkml.org 
[lkml]   [2020]   [Oct]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH] Documentation: filesystems: better locations for sysfs-pci, sysfs-tagging
Date
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
\
 
 \ /
  Last update: 2020-10-08 01:33    [W:0.888 / U:0.060 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site