Re: [PATCH RFC 00/13] Collect documention-related tools under tools/doc

[Jonathan Corbet <corbet@lwn.net>]

[Adding some CCs - sorry, folks, I messed that part up somehow...]

Jonathan Corbet <corbet@lwn.net> writes:

> Our documentation-related tools are spread out over various directories;
> several are buried in the scripts/ dumping ground.  That makes them harder
> to discover and harder to maintain.
>
> Recently, the idea of creating a dedicated directory for documentation tools
> came up; I decided to see what it would look like.  This series creates a
> new directory, tools/doc, and moves various utilities there, hopefully
> fixing up all of the relevant references in the process.
>
> At the end, rather than move the old, Perl kernel-doc, I simply removed it.
>
> The big elephant lurking in this small room is the home for Python modules;
> I left them under scripts/lib, but that is an even less appropriate place
> than it was before.  I would propose either tools/python or lib/python;
> thoughts on that matter welcome.
>
>
> Jonathan Corbet (13):
>   docs: Move the "features" tools to tools/doc
>   docs: move checktransupdate.py to tools/doc
>   docs: move scripts/check-variable-fonts.sh to tools/doc
>   docs: move scripts/documentation-file-ref-check to tools/doc
>   docs: move parallel-wrapper.sh to tools/doc/
>   docs: move get_abi.py to tools/doc
>   docs: move sphinx-pre-install to tools/doc
>   docs: move test_doc_build.py to tools/doc
>   docs: move parse-headers.pl to tools/doc
>   docs: move kernel-doc to tools/doc
>   docs: move split-man.pl to tools/doc
>   docs: move find-unused-docs.sh to tools/doc
>   docs: remove kernel-doc.pl
>
>  Documentation/Kconfig                         |    2 +-
>  Documentation/Makefile                        |   24 +-
>  Documentation/conf.py                         |    2 +-
>  Documentation/doc-guide/checktransupdate.rst  |    6 +-
>  Documentation/doc-guide/contributing.rst      |    2 +-
>  Documentation/doc-guide/kernel-doc.rst        |   18 +-
>  Documentation/doc-guide/parse-headers.rst     |    6 +-
>  Documentation/doc-guide/sphinx.rst            |    6 +-
>  Documentation/kbuild/kbuild.rst               |    2 +-
>  Documentation/process/coding-style.rst        |    2 +-
>  Documentation/sphinx/kernel_abi.py            |    2 +-
>  Documentation/sphinx/kernel_feat.py           |    4 +-
>  Documentation/sphinx/kerneldoc-preamble.sty   |    2 +-
>  .../it_IT/doc-guide/kernel-doc.rst            |    8 +-
>  .../it_IT/doc-guide/parse-headers.rst         |    6 +-
>  .../translations/it_IT/doc-guide/sphinx.rst   |    4 +-
>  .../sp_SP/process/coding-style.rst            |    2 +-
>  .../zh_CN/doc-guide/checktransupdate.rst      |    6 +-
>  .../zh_CN/doc-guide/contributing.rst          |    2 +-
>  .../zh_CN/doc-guide/kernel-doc.rst            |   16 +-
>  .../zh_CN/doc-guide/parse-headers.rst         |    6 +-
>  .../translations/zh_CN/doc-guide/sphinx.rst   |    4 +-
>  Documentation/translations/zh_CN/how-to.rst   |    4 +-
>  .../translations/zh_CN/kbuild/kbuild.rst      |    2 +-
>  .../zh_CN/process/coding-style.rst            |    2 +-
>  .../zh_TW/process/coding-style.rst            |    2 +-
>  Documentation/userspace-api/media/Makefile    |    2 +-
>  MAINTAINERS                                   |   11 +-
>  Makefile                                      |    2 +-
>  drivers/gpu/drm/i915/Makefile                 |    2 +-
>  scripts/kernel-doc                            |    1 -
>  scripts/kernel-doc.pl                         | 2439 -----------------
>  .../doc}/check-variable-fonts.sh              |    2 +-
>  {scripts => tools/doc}/checktransupdate.py    |    8 +-
>  .../doc}/documentation-file-ref-check         |    2 +-
>  .../scripts => tools/doc}/features-refresh.sh |    0
>  {scripts => tools/doc}/find-unused-docs.sh    |    8 +-
>  {scripts => tools/doc}/get_abi.py             |    0
>  {scripts => tools/doc}/get_feat.pl            |    2 +-
>  scripts/kernel-doc.py => tools/doc/kernel-doc |    0
>  .../features => tools/doc}/list-arch.sh       |    2 +-
>  .../sphinx => tools/doc}/parallel-wrapper.sh  |    0
>  .../sphinx => tools/doc}/parse-headers.pl     |    4 +-
>  {scripts => tools/doc}/sphinx-pre-install     |    2 +-
>  {scripts => tools/doc}/split-man.pl           |    0
>  {scripts => tools/doc}/test_doc_build.py      |    0
>  46 files changed, 91 insertions(+), 2538 deletions(-)
>  delete mode 120000 scripts/kernel-doc
>  delete mode 100755 scripts/kernel-doc.pl
>  rename {scripts => tools/doc}/check-variable-fonts.sh (98%)
>  rename {scripts => tools/doc}/checktransupdate.py (98%)
>  rename {scripts => tools/doc}/documentation-file-ref-check (99%)
>  rename {Documentation/features/scripts => tools/doc}/features-refresh.sh (100%)
>  rename {scripts => tools/doc}/find-unused-docs.sh (79%)
>  rename {scripts => tools/doc}/get_abi.py (100%)
>  rename {scripts => tools/doc}/get_feat.pl (99%)
>  rename scripts/kernel-doc.py => tools/doc/kernel-doc (100%)
>  rename {Documentation/features => tools/doc}/list-arch.sh (83%)
>  rename {Documentation/sphinx => tools/doc}/parallel-wrapper.sh (100%)
>  rename {Documentation/sphinx => tools/doc}/parse-headers.pl (98%)
>  rename {scripts => tools/doc}/sphinx-pre-install (99%)
>  rename {scripts => tools/doc}/split-man.pl (100%)
>  rename {scripts => tools/doc}/test_doc_build.py (100%)
>
> -- 
> 2.50.1