| 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
| ||
|
Message-Id: <cover.1606748711.git.mchehab+huawei@kernel.org>
Date: Mon, 30 Nov 2020 16:36:29 +0100
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
"Daniel W. S. Almeida" <dwlsalmeida@...il.com>,
"H. Peter Anvin" <hpa@...or.com>,
"James E.J. Bottomley" <James.Bottomley@...senPartnership.com>,
Jonathan Neuschäfer <j.neuschaefer@....net>,
Albert Ou <aou@...s.berkeley.edu>,
Andrew Cooper <andrew.cooper3@...rix.com>,
Benjamin Herrenschmidt <benh@...nel.crashing.org>,
Borislav Petkov <bp@...en8.de>,
Catalin Marinas <catalin.marinas@....com>,
Christian Borntraeger <borntraeger@...ibm.com>,
Fenghua Yu <fenghua.yu@...el.com>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Heiko Carstens <hca@...ux.ibm.com>,
Helge Deller <deller@....de>, Ingo Molnar <mingo@...hat.com>,
Jonas Bonn <jonas@...thpole.se>,
Kees Cook <keescook@...omium.org>,
Masami Hiramatsu <mhiramat@...nel.org>,
Michael Ellerman <mpe@...erman.id.au>,
Palmer Dabbelt <palmer@...belt.com>,
Paul Mackerras <paulus@...ba.org>,
Paul Walmsley <paul.walmsley@...ive.com>,
Rich Felker <dalias@...c.org>,
Stafford Horne <shorne@...il.com>,
Stefan Kristiansson <stefan.kristiansson@...nalahti.fi>,
Thomas Bogendoerfer <tsbogend@...ha.franken.de>,
Thomas Gleixner <tglx@...utronix.de>,
Tony Luck <tony.luck@...el.com>,
Vasily Gorbik <gor@...ux.ibm.com>,
Will Deacon <will@...nel.org>,
Yoshinori Sato <ysato@...rs.sourceforge.jp>,
linux-arm-kernel@...ts.infradead.org, linux-ia64@...r.kernel.org,
linux-mips@...r.kernel.org, linux-parisc@...r.kernel.org,
linux-riscv@...ts.infradead.org, linux-s390@...r.kernel.org,
linux-sh@...r.kernel.org, linuxppc-dev@...ts.ozlabs.org,
openrisc@...ts.librecores.org, x86@...nel.org
Subject: [PATCH 0/6] Add documentation for Documentation/features at the built docs
Hi Jon,
This series got already submitted last year:
https://lore.kernel.org/lkml/cover.1561222784.git.mchehab+samsung@kernel.org/
Yet, on that time, there were too many other patches related to ReST
conversion floating around. So, at the end, I guess this one got missed.
So, I did a rebase on the top of upstream, and added a few new changes.
Patch 1 contains the original implementation back then. It adds a
get_feat.pl script that parses the contents of Documentation/features.
Patch 2 is new: it re-implements the output of the full contents of the
features table as a set of per-subsystem tables.
Patch 3 replaces the existing Documentation/features/list-arch.sh
by a call to the new script, in order to avoid having two scripts
doing the same thing.
Patch 4 is a sphinx extension to allow generating features output
via a meta-tag.
Patch 5 adds a complete feature list covering all archs at the
admin guide.
Patch 6 adds a per-arch feature list on each architecture book.
-
The scripts/get_feat.pl supports several types of output:
- $ scripts/get_feat.pl current
Outputs the supported feadures by the architecture of the
running Kernel, as an ASCII table;
- $ scripts/get_feat.pl list
Outputs the supported features on an easy to be parsed
format. By default, it uses the current architecture as well;
- $ scripts/get_feat.pl rest --feature jump-labels
Output what architecture supports a given feature
(on the above example, "jump-labels" feature)
- $ scripts/get_feat.pl rest --arch um
Outputs the features support for an specific architecture
(on the above example, for "um" architecture.
- $ scripts/get_feat.pl rest
Outputs a text file with ASCII tables (ReST compatible)
with all features, grouped per subsystem.
E. g. something like:
===================================
Feature status on all architectures
===================================
Subsystem: core
===============
+---------------------+---------------------------------+-------------------------------------------------------------------------+------------+------+
|Feature |Kconfig |Description |Architecture|Status|
+=====================+=================================+=========================================================================+============+======+
|cBPF-JIT |HAVE_CBPF_JIT |arch supports cBPF JIT optimizations |alpha |TODO |
| | | +------------+------+
| | | |arc |TODO |
| | | +------------+------+
| | | |arm |TODO |
| | | +------------+------+
| | | |arm64 |TODO |
| | | +------------+------+
| | | |c6x |TODO |
| | | +------------+------+
| | | |csky |TODO |
| | | +------------+------+
| | | |h8300 |TODO |
| | | +------------+------+
| | | |hexagon |TODO |
...
Adding those patchsets will basically place the contents of all
files under Documentation/features (currently, 45 files) at the
Kernel documentation, which is, IMO, a good thing to do.
Regards,
Mauro
Mauro Carvalho Chehab (6):
scripts: get_feat.pl: add a script to handle Documentation/features
scripts: get_feat.pl: improve matrix output
scripts: get_feat.pl: use its implementation for list-arch.sh
sphinx: kernel_feat.py: add a script to parse feature files
docs: admin-guide: add a features list
docs: archis: add a per-architecture features list
Documentation/admin-guide/features.rst | 3 +
Documentation/admin-guide/index.rst | 1 +
Documentation/arm/features.rst | 3 +
Documentation/arm/index.rst | 2 +
Documentation/arm64/features.rst | 3 +
Documentation/arm64/index.rst | 2 +
Documentation/conf.py | 2 +-
Documentation/features/list-arch.sh | 17 +-
Documentation/ia64/features.rst | 3 +
Documentation/ia64/index.rst | 2 +
Documentation/index.rst | 2 +-
Documentation/m68k/features.rst | 3 +
Documentation/m68k/index.rst | 2 +
Documentation/mips/features.rst | 3 +
Documentation/mips/index.rst | 2 +
Documentation/nios2/index.rst | 12 +
Documentation/openrisc/features.rst | 3 +
Documentation/openrisc/index.rst | 2 +
Documentation/parisc/features.rst | 3 +
Documentation/parisc/index.rst | 2 +
Documentation/powerpc/features.rst | 3 +
Documentation/powerpc/index.rst | 2 +
Documentation/riscv/features.rst | 3 +
Documentation/riscv/index.rst | 2 +
Documentation/s390/features.rst | 3 +
Documentation/s390/index.rst | 2 +
Documentation/sh/features.rst | 3 +
Documentation/sh/index.rst | 2 +
Documentation/sparc/features.rst | 3 +
Documentation/sparc/index.rst | 2 +
Documentation/sphinx/kernel_feat.py | 169 ++++++++
Documentation/x86/features.rst | 3 +
Documentation/x86/index.rst | 1 +
Documentation/xtensa/features.rst | 3 +
Documentation/xtensa/index.rst | 2 +
scripts/get_feat.pl | 552 +++++++++++++++++++++++++
36 files changed, 810 insertions(+), 17 deletions(-)
create mode 100644 Documentation/admin-guide/features.rst
create mode 100644 Documentation/arm/features.rst
create mode 100644 Documentation/arm64/features.rst
create mode 100644 Documentation/ia64/features.rst
create mode 100644 Documentation/m68k/features.rst
create mode 100644 Documentation/mips/features.rst
create mode 100644 Documentation/nios2/index.rst
create mode 100644 Documentation/openrisc/features.rst
create mode 100644 Documentation/parisc/features.rst
create mode 100644 Documentation/powerpc/features.rst
create mode 100644 Documentation/riscv/features.rst
create mode 100644 Documentation/s390/features.rst
create mode 100644 Documentation/sh/features.rst
create mode 100644 Documentation/sparc/features.rst
create mode 100644 Documentation/sphinx/kernel_feat.py
create mode 100644 Documentation/x86/features.rst
create mode 100644 Documentation/xtensa/features.rst
create mode 100755 scripts/get_feat.pl
--
2.28.0
Powered by blists - more mailing lists