Re: [PATCH 1/5] Docs: changes.rst: rename file and references and add links

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] Newly created symlinks point to absolute paths specific to the author's local machine instead of relative paths.
- [Low] Sphinx :ref: targets were renamed in referencing files, but the corresponding anchor labels in the target documents were not updated, which breaks the documentation build.
--

--- Patch [1]: [PATCH 1/5] Docs: changes.rst: rename file and references and  add links ---
commit c768ca54c0ac770b2315f64aa918063f10522512
Author: Manuel Ebner <manuelebnerli@mailbox.org>

Docs: changes.rst: rename file and references and add links

This commit renames changes.rst to software-requirements.rst to better reflect
its content. It updates references in documentation, translations, and scripts,
and sets up symlinks for backward compatibility.

> diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst
> index 77fec1de6dc86..9d1e1938b23d0 100644
> --- a/Documentation/admin-guide/README.rst
> +++ b/Documentation/admin-guide/README.rst
> @@ -52,7 +52,7 @@ Documentation
>   - There are various README files in the Documentation/ subdirectory:
>     these typically contain kernel-specific installation notes for some
>     drivers for example. Please read the
> -   :ref:`Documentation/process/changes.rst <changes>` file, as it
> +   :ref:`Documentation/process/software-requirements.rst <software-requirements>` file, as it
                                                              ^^^^^^^^^^^^^^^^^^^^^

[Severity: Low]
Does this update break the documentation build? The target document still uses
the legacy label .. _changes: instead of .. _software-requirements: .

[ ... ]

> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> new file mode 120000
> index 0000000000000..ef3fa664d434d
> --- /dev/null
> +++ b/Documentation/process/changes.rst
> @@ -0,0 +1 @@
> +/home/manuel/linux/Documentation/process/software-requirements.rst
\ No newline at end of file

[Severity: Low]
Does this symlink point to an absolute path on your local machine? This will
be broken for anyone checking out the repository since the path will not exist
on their system. Should this be a relative path instead?

[ ... ]

> diff --git a/Documentation/process/software-requirements.rst b/Documentation/process/software-requirements.rst
> new file mode 100644
> index 0000000000000..1ca8c5f73ad00
> --- /dev/null
> +++ b/Documentation/process/software-requirements.rst
> @@ -0,0 +1,575 @@
> +.. _changes:
    ^^^^^^^^^^

[Severity: Low]
Should this anchor label be updated to .. _software-requirements: so the new
references can find it?

[ ... ]

> diff --git a/Documentation/translations/it_IT/process/changes.rst b/Documentation/translations/it_IT/process/changes.rst
> new file mode 120000
> index 0000000000000..d949784418927
> --- /dev/null
> +++ b/Documentation/translations/it_IT/process/changes.rst
> @@ -0,0 +1 @@
> +/home/manuel/linux/Documentation/translations/it_IT/process/software-requirements.rst
\ No newline at end of file

[Severity: Low]
Are there multiple absolute symlinks here? This also points to a local path
that will fail for other users.

[ ... ]

> diff --git a/Documentation/translations/it_IT/process/howto.rst b/Documentation/translations/it_IT/process/howto.rst
> index f51288602ee3d..37ca98764932f 100644
> --- a/Documentation/translations/it_IT/process/howto.rst
> +++ b/Documentation/translations/it_IT/process/howto.rst
> @@ -96,7 +96,7 @@ Di seguito una lista di file che sono presenti nei sorgente del kernel e che
>      minimo necessario per configurare e generare il kernel. I novizi
>      del kernel dovrebbero iniziare da qui.
>  
> -  :ref:`Documentation/translations/it_IT/process/changes.rst <it_changes>`
> +  :ref:`Documentation/translations/it_IT/process/software-requirements.rst <itsoftware-requirements>`

[Severity: Low]
This link is updated to use the <itsoftware-requirements> label, but the
target document still defines .. _it_changes: . Will this cause a Sphinx
reference error during the documentation build?

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260812120805.1631430-3-manuelebnerli@mailbox.org?part=1