Update Documentation/00-INDEX
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest5 patches 4 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/5 | scripts: add a script to check if Documentation/00-INDEX is sanescripts/ | +66 | 0 replies | |
| 2/5 | docs: 00-INDEX: consolidate process/ and admin-guide/ descriptionDocumentation/ | +4 | 0 replies | |
| 3/5 | docs: 00-INDEX: add missing entries for documentation files/dirsDocumentation/ | +60 | 0 replies | |
| 4/5 | docs: 00-INDEX: remove non-existing entriesDocumentation/ | +0 | 0 replies | |
| 5/5 | docs: 00-INDEX: document directories/files with no docsDocumentation/ | +19 | 2 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
Cover letter [PATCH 0/5] Update Documentation/00-INDEX
Keeping a manually filled index over time is not perfect, as people often forget to keep the index file updated.
As Brian noticed, the recent conversion to ReST caused some new issues. It turns, however, that the problem with this file predates the ReST conversion, as several entries were missing, including really old ones like PCI/ and isa.txt.
Well, after converting everything to ReST file, the 00-INDEX one will become obsoleted by index.rst, but, as there are still a lot stuff to do, it will take some time.
So, in order to check it, I wrote a small script that compares the files and directories at Documentation/ with the ones at 00-INDEX.
Then, I synchronized the entries, making the script happy.
We might think on integrating the script with checkpatch.pl, but, as we should get rid of 00-INDEX, it probably not worth the efforts.
Mauro Carvalho Chehab (5):
scripts: add a script to check if Documentation/00-INDEX is sane
docs: 00-INDEX: consolidate process/ and admin-guide/ description
docs: 00-INDEX: add missing entries for documentation files/dirs
docs: 00-INDEX: remove non-existing entries
docs: 00-INDEX: document directories/files with no docs
Documentation/00-INDEX | 196 ++++++++++++++++++++--------------------------- scripts/check_00index.sh | 66 ++++++++++++++++ 2 files changed, 149 insertions(+), 113 deletions(-) create mode 100755 scripts/check_00index.sh
Signature · 1 line
2.9.3