linux-kernel - [PATCH v2] Documentation: better locations for sysfs-pci, sysfs-tagging

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20201009070128.118639-1-jhubbard@nvidia.com>
Date:   Fri, 9 Oct 2020 00:01:28 -0700
From:   John Hubbard <jhubbard@...dia.com>
To:     Jonathan Corbet <corbet@....net>
CC:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Jan Kara <jack@...e.cz>, David Sterba <dsterba@...e.com>,
        <linux-doc@...r.kernel.org>, LKML <linux-kernel@...r.kernel.org>,
        John Hubbard <jhubbard@...dia.com>
Subject: [PATCH v2] Documentation: better locations for sysfs-pci, sysfs-tagging

sysfs-pci and sysfs-tagging were mis-filed: their locations within
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 to PCI, and move sysfs-tagging to networking. (Thanks to
Jonathan Corbet for coming up with the final locations.)

Signed-off-by: John Hubbard <jhubbard@...dia.com>
---

Changes since v1: moved sysfs-pci to PCI, and sysfs-tagging to
networking, and poked around in the generated HTML via Firefox.
It looks like the right place now.

thanks,
John Hubbard
NVIDIA


 Documentation/PCI/index.rst                                 | 1 +
 Documentation/{filesystems => PCI}/sysfs-pci.rst            | 0
 Documentation/filesystems/index.rst                         | 2 --
 Documentation/networking/index.rst                          | 1 +
 Documentation/{filesystems => networking}/sysfs-tagging.rst | 0
 5 files changed, 2 insertions(+), 2 deletions(-)
 rename Documentation/{filesystems => PCI}/sysfs-pci.rst (100%)
 rename Documentation/{filesystems => networking}/sysfs-tagging.rst (100%)

diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
index 8f66feaafd4f..c17c87af1968 100644
--- a/Documentation/PCI/index.rst
+++ b/Documentation/PCI/index.rst
@@ -12,6 +12,7 @@ Linux PCI Bus Subsystem
    pciebus-howto
    pci-iov-howto
    msi-howto
+   sysfs-pci
    acpi-info
    pci-error-recovery
    pcieaer-howto
diff --git a/Documentation/filesystems/sysfs-pci.rst b/Documentation/PCI/sysfs-pci.rst
similarity index 100%
rename from Documentation/filesystems/sysfs-pci.rst
rename to Documentation/PCI/sysfs-pci.rst
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/networking/index.rst b/Documentation/networking/index.rst
index c29496fff81c..611e4b130c1e 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -95,6 +95,7 @@ Contents:
    seg6-sysctl
    strparser
    switchdev
+   sysfs-tagging
    tc-actions-env-rules
    tcp-thin
    team
diff --git a/Documentation/filesystems/sysfs-tagging.rst b/Documentation/networking/sysfs-tagging.rst
similarity index 100%
rename from Documentation/filesystems/sysfs-tagging.rst
rename to Documentation/networking/sysfs-tagging.rst
-- 
2.28.0