Re: [PATCH RFC 1/3] docs: add scripts/documentation-gen-renames.py

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Vegard Nossum <vegard.nossum@xxxxxxxxxx> writes:

> Add a new script that wraps git to trawl the repository history for
> renames of .rst files in the Documentation/ directory.
>
> Example usage:
>
>   scripts/documentation-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@xxxxxxxxxx>
> ---
>  scripts/documentation-gen-renames.py | 122 +++++++++++++++++++++++++++
>  1 file changed, 122 insertions(+)
>  create mode 100755 scripts/documentation-gen-renames.py

No cover letter?

It seems to work as advertised, thanks.

One request: the plan is to move all of the documentation-related tools
into tools/docs once the churn settles a bit.  Rather can making us
... rename ... these, can you just create them there in the first place?
At that point, the "documentation-" prefix on the names would also be
unnecessary.

The programs need SPDX lines at the top.  Can we also get a brief
comment block at the beginning of each saying what they do and how to
run them?

I'm not convinced about ".renames" as a hidden file, but I guess I'm not
deeply opposed to it either.

Thanks,

jon




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux