linux-kernel - Re: [PATCH v2] docs: automatic redirects for moved pages

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-prev] [day] [month] [year] [list]

Message-ID: <87lei89o0k.fsf@meer.lwn.net>
Date:   Mon, 01 May 2023 07:31:23 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Costa Shulyupin <costa.shul@...hat.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        linux-doc@...r.kernel.org
Cc:     Costa Shulyupin <costa.shul@...hat.com>,
        open list <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v2] docs: automatic redirects for moved pages

Costa Shulyupin <costa.shul@...hat.com> writes:

> Problems:
> - The documentation is not well-organized
> - Relocating pages disrupts external links to
>   the documentation and causes confusion for users
>
> Benefits:
> - Users can easily access relocated pages from external resources
> - Using redirects frees up options for reorganizing the documentation
>
> The solution:
> - To prevent the need for ongoing maintenance, extract renames
>   from git log since specified age
> - Input the renames into sphinx_reredirects module
>
> Signed-off-by: Costa Shulyupin <costa.shul@...hat.com>
>
> ---
>
> Changes:
> - added the extraction of renames from Git.
>
> ---
>  Documentation/Makefile                |  8 +++++++-
>  Documentation/conf.py                 | 17 ++++++++++++++++-
>  Documentation/sphinx/requirements.txt |  1 +
>  3 files changed, 24 insertions(+), 2 deletions(-)

So this adds another time-consuming process to the docs build,
generating over 2600 redirects, and breaking the build if it's not done
in a git tree.  All for a problem that still has not actually been
demonstrated to exist.

Costa, I appreciate that you are trying to help, but this is getting
worse, not better.  Please, let's wait until an actual problem arises,
then we can talk about the best way to address it.

Thanks,

jon