From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
LKML <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Brian Norris <computersforpeace@gmail.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: [PATCH 0/5] Update Documentation/00-INDEX
Date: Mon, 5 Dec 2016 09:41:40 -0200 [thread overview]
Message-ID: <cover.1480937715.git.mchehab@s-opensource.com> (raw)
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
--
2.9.3
next reply other threads:[~2016-12-05 12:13 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-05 11:41 Mauro Carvalho Chehab [this message]
2016-12-05 11:41 ` [PATCH 1/5] scripts: add a script to check if Documentation/00-INDEX is sane Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 2/5] docs: 00-INDEX: consolidate process/ and admin-guide/ description Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 3/5] docs: 00-INDEX: add missing entries for documentation files/dirs Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 4/5] docs: 00-INDEX: remove non-existing entries Mauro Carvalho Chehab
2016-12-05 11:41 ` [PATCH 5/5] docs: 00-INDEX: document directories/files with no docs Mauro Carvalho Chehab
2016-12-05 21:25 ` Jonathan Corbet
2016-12-06 12:41 ` Mauro Carvalho Chehab
2016-12-05 21:23 ` [PATCH 0/5] Update Documentation/00-INDEX Jonathan Corbet
2016-12-06 12:51 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1480937715.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=computersforpeace@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=mchehab@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).