Re: [PATCH] docs: update sysfs docs

From: Jonathan Corbet
Date: Mon Oct 14 2024 - 15:29:51 EST


Vishnu Sanal T <t.v.s10123@xxxxxxxxx> writes:

> update sysfs docs with documentation for all the subdirectories
>
> Signed-off-by: Vishnu Sanal T <t.v.s10123@xxxxxxxxx>
> ---
> Documentation/filesystems/sysfs.rst | 57 ++++++++++++++++++++---------
> 1 file changed, 39 insertions(+), 18 deletions(-)
>
> diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
> index c32993bc83c7..b455ab32aacc 100644
> --- a/Documentation/filesystems/sysfs.rst
> +++ b/Documentation/filesystems/sysfs.rst
> @@ -302,43 +302,64 @@ The top level sysfs directory looks like::
> net/
> power/
>
> -devices/ contains a filesystem representation of the device tree. It maps
> -directly to the internal kernel device tree, which is a hierarchy of
> -struct device.
> +block/ contains subdirectories for each block device that has been
> +discovered in the system. In each block device's directory are attributes
> +that describe many things, including the size of the device and the
> +dev_t number that it maps to.
>
> bus/ contains flat directory layout of the various bus types in the
> kernel. Each bus's directory contains two subdirectories::
>
> - devices/
> - drivers/
> + bus/devices/
> + bus/drivers/

This is overtly wrong, that is not how the directories are named. The
original may not have been as clear as it could be, but it was at least
correct.

Please have another look.

jon