[PATCH v2 0/3] docs: new scripts to generate HTML redirects

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

 



Hi,

When we rename an .rst file, that also changes the URL for the document
at https://docs.kernel.org/ and results in a 404, which can be anonying
for people who bookmark URLs and/or follow links from search engines
and old changelogs and emails.

In order to be able to fearlessly rename individual documentation files
and reorganize Documentation/, add two scripts:

- tools/docs/gen-renames.py : use git to figure out which .rst files
  have been renamed

- tools/docs/gen-redirects.py : actually generate .html stubs for the
  locations, redirecting to the new locations

The reason for splitting this into two is that trawling git history is
slightly slow (on the order of 20-30 seconds on my laptop) whereas just
generating the HTML files is very fast. This also allows us to cache
the historical renames in Documentation/.renames.txt or add manual
fixups as needed.

Changes since v1:

- cover letter
- move files from scripts/ -> tools/docs/
- add SPDX lines
- program doc strings + improved --help


Vegard

---

Vegard Nossum (3):
  docs: add tools/docs/gen-renames.py
  docs: add Documentation/.renames.txt
  docs: add tools/docs/gen-redirects.py

 Documentation/.renames.txt  | 1191 +++++++++++++++++++++++++++++++++++
 Documentation/Makefile      |    4 +
 Makefile                    |    5 +-
 tools/docs/gen-redirects.py |   54 ++
 tools/docs/gen-renames.py   |  130 ++++
 5 files changed, 1382 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/.renames.txt
 create mode 100755 tools/docs/gen-redirects.py
 create mode 100755 tools/docs/gen-renames.py

-- 
2.34.1





[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