]> git.ipfire.org Git - thirdparty/linux.git/commit
docs: add tools/docs/gen-renames.py
authorVegard Nossum <vegard.nossum@oracle.com>
Fri, 5 Sep 2025 14:46:06 +0000 (16:46 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 9 Sep 2025 19:37:16 +0000 (13:37 -0600)
commit2f1c96018b10e6d42280db3a6faa47d80c961b6b
treefcb1032346487ef7de3e7fa74db7968be7f1d864
parentf874abea20bc381ecf3cab6dad56c5ff66d1a5cc
docs: add tools/docs/gen-renames.py

Add a new script that wraps git to trawl the repository history for
renames of .rst files in the Documentation/ directory.

Example usage:

  tools/docs/gen-renames.py --rev v6.17-rc3 > Documentation/.renames.txt

The output format is simply:

  <old path> SPACE <new path> NEWLINE

where neither <old path> nor <new path> contain the Documentation/
prefix or the .rst suffix. The file is sorted alphabetically.

We can suggest rerunning the script for future renames (and squash the
resulting change) or rerun it periodically to keep the file up to date.

Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20250905144608.577449-2-vegard.nossum@oracle.com>
tools/docs/gen-renames.py [new file with mode: 0755]