2023-05-01 15:53:11

by Costa Shulyupin

[permalink] [raw]
Subject: [PATCH v2] docs: consolidate human interface subsystems

to make the page more organized as requested

Signed-off-by: Costa Shulyupin <[email protected]>
---
Changes:
- fixed typo

---
Documentation/subsystem-apis.rst | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index b51f38527e14..287799ee2419 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,6 +10,18 @@ is taken directly from the kernel source, with supplemental material added
as needed (or at least as we managed to add it — probably *not* all that is
needed).

+Human interfaces
+---------------
+
+.. toctree::
+ :maxdepth: 1
+
+ input/index
+ hid/index
+ sound/index
+ gpu/index
+ fb/index
+
**Fixme**: much more organizational work is needed here.

.. toctree::
@@ -22,9 +34,7 @@ needed).
block/index
cdrom/index
cpu-freq/index
- fb/index
fpga/index
- hid/index
i2c/index
iio/index
isdn/index
@@ -40,12 +50,9 @@ needed).
w1/index
watchdog/index
virt/index
- input/index
hwmon/index
- gpu/index
accel/index
security/index
- sound/index
crypto/index
filesystems/index
mm/index
--
2.40.0


2023-05-01 19:26:49

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH v2] docs: consolidate human interface subsystems

Hi,

On 5/1/23 08:42, Costa Shulyupin wrote:
> to make the page more organized as requested
>
> Signed-off-by: Costa Shulyupin <[email protected]>
> ---
> Changes:
> - fixed typo
>
> ---
> Documentation/subsystem-apis.rst | 17 ++++++++++++-----
> 1 file changed, 12 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
> index b51f38527e14..287799ee2419 100644
> --- a/Documentation/subsystem-apis.rst
> +++ b/Documentation/subsystem-apis.rst
> @@ -10,6 +10,18 @@ is taken directly from the kernel source, with supplemental material added
> as needed (or at least as we managed to add it — probably *not* all that is
> needed).
>
> +Human interfaces
> +---------------

Did you test this?
I would expect a complaint about the underline not being long enough,
although I didn't test it either...

> +
> +.. toctree::
> + :maxdepth: 1
> +
> + input/index
> + hid/index
> + sound/index
> + gpu/index
> + fb/index
> +
> **Fixme**: much more organizational work is needed here.
>
> .. toctree::
> @@ -22,9 +34,7 @@ needed).
> block/index
> cdrom/index
> cpu-freq/index
> - fb/index
> fpga/index
> - hid/index
> i2c/index
> iio/index
> isdn/index
> @@ -40,12 +50,9 @@ needed).
> w1/index
> watchdog/index
> virt/index
> - input/index
> hwmon/index
> - gpu/index
> accel/index
> security/index
> - sound/index
> crypto/index
> filesystems/index
> mm/index

Thanks.
--
~Randy

2023-05-02 01:52:45

by Costa Shulyupin

[permalink] [raw]
Subject: [PATCH v3] docs: consolidate human interface subsystems

to make the page more organized as requested

Signed-off-by: Costa Shulyupin <[email protected]>
---
Changes:
- fixed typo
- fixed underline

---
Documentation/subsystem-apis.rst | 17 ++++++++++++-----
1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index b51f38527e14..287799ee2419 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -10,6 +10,18 @@ is taken directly from the kernel source, with supplemental material added
as needed (or at least as we managed to add it — probably *not* all that is
needed).

+Human interfaces
+----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ input/index
+ hid/index
+ sound/index
+ gpu/index
+ fb/index
+
**Fixme**: much more organizational work is needed here.

.. toctree::
@@ -22,9 +34,7 @@ needed).
block/index
cdrom/index
cpu-freq/index
- fb/index
fpga/index
- hid/index
i2c/index
iio/index
isdn/index
@@ -40,12 +50,9 @@ needed).
w1/index
watchdog/index
virt/index
- input/index
hwmon/index
- gpu/index
accel/index
security/index
- sound/index
crypto/index
filesystems/index
mm/index
--
2.40.0

2023-05-02 05:39:37

by kernel test robot

[permalink] [raw]
Subject: Re: [PATCH v2] docs: consolidate human interface subsystems

Hi Costa,

kernel test robot noticed the following build warnings:

[auto build test WARNING on lwn/docs-next]
[also build test WARNING on linus/master v6.3 next-20230428]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Costa-Shulyupin/docs-consolidate-human-interface-subsystems/20230501-234438
base: git://git.lwn.net/linux.git docs-next
patch link: https://lore.kernel.org/r/20230501154258.277866-1-costa.shul%40redhat.com
patch subject: [PATCH v2] docs: consolidate human interface subsystems
reproduce:
# https://github.com/intel-lab-lkp/linux/commit/2df620e4b9e2c2827f8a5519f6c266e9e5ef85be
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Costa-Shulyupin/docs-consolidate-human-interface-subsystems/20230501-234438
git checkout 2df620e4b9e2c2827f8a5519f6c266e9e5ef85be
make menuconfig
# enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
make htmldocs

If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All warnings (new ones prefixed by >>):

>> Documentation/subsystem-apis.rst:14: WARNING: Title underline too short.

vim +14 Documentation/subsystem-apis.rst

12
13 Human interfaces
> 14 ---------------
15

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests

2023-05-02 14:54:31

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH v2] docs: consolidate human interface subsystems

Hi bot,

Already reported and fixed.
Thanks.

On 5/1/23 22:37, kernel test robot wrote:
> Hi Costa,
>
> kernel test robot noticed the following build warnings:
>
> [auto build test WARNING on lwn/docs-next]
> [also build test WARNING on linus/master v6.3 next-20230428]
> [If your patch is applied to the wrong git tree, kindly drop us a note.
> And when submitting patch, we suggest to use '--base' as documented in
> https://git-scm.com/docs/git-format-patch#_base_tree_information]
>
> url: https://github.com/intel-lab-lkp/linux/commits/Costa-Shulyupin/docs-consolidate-human-interface-subsystems/20230501-234438
> base: git://git.lwn.net/linux.git docs-next
> patch link: https://lore.kernel.org/r/20230501154258.277866-1-costa.shul%40redhat.com
> patch subject: [PATCH v2] docs: consolidate human interface subsystems
> reproduce:
> # https://github.com/intel-lab-lkp/linux/commit/2df620e4b9e2c2827f8a5519f6c266e9e5ef85be
> git remote add linux-review https://github.com/intel-lab-lkp/linux
> git fetch --no-tags linux-review Costa-Shulyupin/docs-consolidate-human-interface-subsystems/20230501-234438
> git checkout 2df620e4b9e2c2827f8a5519f6c266e9e5ef85be
> make menuconfig
> # enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
> make htmldocs
>
> If you fix the issue, kindly add following tag where applicable
> | Reported-by: kernel test robot <[email protected]>
> | Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
>
> All warnings (new ones prefixed by >>):
>
>>> Documentation/subsystem-apis.rst:14: WARNING: Title underline too short.
>
> vim +14 Documentation/subsystem-apis.rst
>
> 12
> 13 Human interfaces
> > 14 ---------------
> 15
>

--
~Randy

2023-05-19 15:01:21

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v3] docs: consolidate human interface subsystems

Costa Shulyupin <[email protected]> writes:

> to make the page more organized as requested
>
> Signed-off-by: Costa Shulyupin <[email protected]>
> ---
> Changes:
> - fixed typo
> - fixed underline
>
> ---
> Documentation/subsystem-apis.rst | 17 ++++++++++++-----
> 1 file changed, 12 insertions(+), 5 deletions(-)

Applied.

Thanks,

jon