linux-kernel - [PATCH 0/5] Update Documentation/00-INDEX

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <cover.1480937715.git.mchehab@s-opensource.com>
Date:   Mon,  5 Dec 2016 09:41:40 -0200
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Brian Norris <computersforpeace@...il.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Subject: [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

-- 
2.9.3