* [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs
@ 2020-11-30 15:36 Mauro Carvalho Chehab
2020-11-30 15:36 ` [OpenRISC] [PATCH 6/6] docs: archis: add a per-architecture features list Mauro Carvalho Chehab
2020-12-03 22:36 ` [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs Jonathan Corbet
0 siblings, 2 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-30 15:36 UTC (permalink / raw)
To: openrisc
Hi Jon,
This series got already submitted last year:
https://lore.kernel.org/lkml/cover.1561222784.git.mchehab+samsung at 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
^ permalink raw reply [flat|nested] 3+ messages in thread
* [OpenRISC] [PATCH 6/6] docs: archis: add a per-architecture features list
2020-11-30 15:36 [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs Mauro Carvalho Chehab
@ 2020-11-30 15:36 ` Mauro Carvalho Chehab
2020-12-03 22:36 ` [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-30 15:36 UTC (permalink / raw)
To: openrisc
Add a feature list matrix for each architecture to their
respective Kernel books.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/arm/features.rst | 3 +++
Documentation/arm/index.rst | 2 ++
Documentation/arm64/features.rst | 3 +++
Documentation/arm64/index.rst | 2 ++
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/x86/features.rst | 3 +++
Documentation/x86/index.rst | 1 +
Documentation/xtensa/features.rst | 3 +++
Documentation/xtensa/index.rst | 2 ++
30 files changed, 82 insertions(+), 1 deletion(-)
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/x86/features.rst
create mode 100644 Documentation/xtensa/features.rst
diff --git a/Documentation/arm/features.rst b/Documentation/arm/features.rst
new file mode 100644
index 000000000000..7414ec03dd15
--- /dev/null
+++ b/Documentation/arm/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features arm
diff --git a/Documentation/arm/index.rst b/Documentation/arm/index.rst
index 5fc072dd0c5e..a2e9e1bba7b9 100644
--- a/Documentation/arm/index.rst
+++ b/Documentation/arm/index.rst
@@ -23,6 +23,8 @@ ARM Architecture
vlocks
porting
+ features
+
SoC-specific documents
======================
diff --git a/Documentation/arm64/features.rst b/Documentation/arm64/features.rst
new file mode 100644
index 000000000000..dfa4cb3cd3ef
--- /dev/null
+++ b/Documentation/arm64/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features arm64
diff --git a/Documentation/arm64/index.rst b/Documentation/arm64/index.rst
index 937634c49979..97d65ba12a35 100644
--- a/Documentation/arm64/index.rst
+++ b/Documentation/arm64/index.rst
@@ -24,6 +24,8 @@ ARM64 Architecture
tagged-address-abi
tagged-pointers
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/ia64/features.rst b/Documentation/ia64/features.rst
new file mode 100644
index 000000000000..d7226fdcf5f8
--- /dev/null
+++ b/Documentation/ia64/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features ia64
diff --git a/Documentation/ia64/index.rst b/Documentation/ia64/index.rst
index 4bdfe28067ee..761f2154dfa2 100644
--- a/Documentation/ia64/index.rst
+++ b/Documentation/ia64/index.rst
@@ -15,3 +15,5 @@ IA-64 Architecture
irq-redir
mca
serial
+
+ features
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 57719744774c..5888e8a7272f 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -160,7 +160,7 @@ implementation.
ia64/index
m68k/index
mips/index
- nios2/nios2
+ nios2/index
openrisc/index
parisc/index
powerpc/index
diff --git a/Documentation/m68k/features.rst b/Documentation/m68k/features.rst
new file mode 100644
index 000000000000..5107a2119472
--- /dev/null
+++ b/Documentation/m68k/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features m68k
diff --git a/Documentation/m68k/index.rst b/Documentation/m68k/index.rst
index b89cb6a86d9b..0f890dbb5fe2 100644
--- a/Documentation/m68k/index.rst
+++ b/Documentation/m68k/index.rst
@@ -10,6 +10,8 @@ m68k Architecture
kernel-options
buddha-driver
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/mips/features.rst b/Documentation/mips/features.rst
new file mode 100644
index 000000000000..1973d729b29a
--- /dev/null
+++ b/Documentation/mips/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features mips
diff --git a/Documentation/mips/index.rst b/Documentation/mips/index.rst
index 35cceea4e8bc..037f85a08fe3 100644
--- a/Documentation/mips/index.rst
+++ b/Documentation/mips/index.rst
@@ -11,6 +11,8 @@ MIPS-specific Documentation
booting
ingenic-tcu
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/nios2/index.rst b/Documentation/nios2/index.rst
new file mode 100644
index 000000000000..4468fe1a1037
--- /dev/null
+++ b/Documentation/nios2/index.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============================
+Nios II Specific Documentation
+==============================
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ nios2
+ features
diff --git a/Documentation/openrisc/features.rst b/Documentation/openrisc/features.rst
new file mode 100644
index 000000000000..3f7c40d219f2
--- /dev/null
+++ b/Documentation/openrisc/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features openrisc
diff --git a/Documentation/openrisc/index.rst b/Documentation/openrisc/index.rst
index 748b3eea1707..6879f998b87a 100644
--- a/Documentation/openrisc/index.rst
+++ b/Documentation/openrisc/index.rst
@@ -10,6 +10,8 @@ OpenRISC Architecture
openrisc_port
todo
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/parisc/features.rst b/Documentation/parisc/features.rst
new file mode 100644
index 000000000000..501d7c450037
--- /dev/null
+++ b/Documentation/parisc/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features parisc
diff --git a/Documentation/parisc/index.rst b/Documentation/parisc/index.rst
index aa3ee0470425..240685751825 100644
--- a/Documentation/parisc/index.rst
+++ b/Documentation/parisc/index.rst
@@ -10,6 +10,8 @@ PA-RISC Architecture
debugging
registers
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/powerpc/features.rst b/Documentation/powerpc/features.rst
new file mode 100644
index 000000000000..aeae73df86b0
--- /dev/null
+++ b/Documentation/powerpc/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features powerpc
diff --git a/Documentation/powerpc/index.rst b/Documentation/powerpc/index.rst
index 6ec64b0d5257..bf5f1a2bdbdf 100644
--- a/Documentation/powerpc/index.rst
+++ b/Documentation/powerpc/index.rst
@@ -34,6 +34,8 @@ powerpc
vas-api
vcpudispatch_stats
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/riscv/features.rst b/Documentation/riscv/features.rst
new file mode 100644
index 000000000000..c70ef6ac2368
--- /dev/null
+++ b/Documentation/riscv/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features riscv
diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst
index fa33bffd8992..6e6e39482502 100644
--- a/Documentation/riscv/index.rst
+++ b/Documentation/riscv/index.rst
@@ -9,6 +9,8 @@ RISC-V architecture
pmu
patch-acceptance
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/s390/features.rst b/Documentation/s390/features.rst
new file mode 100644
index 000000000000..57c296a9d8f3
--- /dev/null
+++ b/Documentation/s390/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features s390
diff --git a/Documentation/s390/index.rst b/Documentation/s390/index.rst
index cf71df5776b4..b10ca9192557 100644
--- a/Documentation/s390/index.rst
+++ b/Documentation/s390/index.rst
@@ -19,6 +19,8 @@ s390 Architecture
text_files
+ features
+
.. only:: subproject and html
Indices
diff --git a/Documentation/sh/features.rst b/Documentation/sh/features.rst
new file mode 100644
index 000000000000..f722af3b6c99
--- /dev/null
+++ b/Documentation/sh/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features sh
diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst
index 7b9a79a28167..c64776738cf6 100644
--- a/Documentation/sh/index.rst
+++ b/Documentation/sh/index.rst
@@ -11,6 +11,8 @@ SuperH Interfaces Guide
new-machine
register-banks
+ features
+
Memory Management
=================
diff --git a/Documentation/sparc/features.rst b/Documentation/sparc/features.rst
new file mode 100644
index 000000000000..c0c92468b0fe
--- /dev/null
+++ b/Documentation/sparc/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features sparc
diff --git a/Documentation/sparc/index.rst b/Documentation/sparc/index.rst
index 71cff621f243..ae884224eec2 100644
--- a/Documentation/sparc/index.rst
+++ b/Documentation/sparc/index.rst
@@ -9,3 +9,5 @@ Sparc Architecture
adi
oradax/oracle-dax
+
+ features
diff --git a/Documentation/x86/features.rst b/Documentation/x86/features.rst
new file mode 100644
index 000000000000..b663f15053ce
--- /dev/null
+++ b/Documentation/x86/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features x86
diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst
index b224d12c880b..b4fcb6f258b2 100644
--- a/Documentation/x86/index.rst
+++ b/Documentation/x86/index.rst
@@ -33,3 +33,4 @@ x86-specific Documentation
i386/index
x86_64/index
sva
+ features
diff --git a/Documentation/xtensa/features.rst b/Documentation/xtensa/features.rst
new file mode 100644
index 000000000000..6b92c7bfa19d
--- /dev/null
+++ b/Documentation/xtensa/features.rst
@@ -0,0 +1,3 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. kernel-feat:: $srctree/Documentation/features xtensa
diff --git a/Documentation/xtensa/index.rst b/Documentation/xtensa/index.rst
index 52fa04eb39a3..69952446a9be 100644
--- a/Documentation/xtensa/index.rst
+++ b/Documentation/xtensa/index.rst
@@ -10,3 +10,5 @@ Xtensa Architecture
atomctl
booting
mmu
+
+ features
--
2.28.0
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs
2020-11-30 15:36 [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs Mauro Carvalho Chehab
2020-11-30 15:36 ` [OpenRISC] [PATCH 6/6] docs: archis: add a per-architecture features list Mauro Carvalho Chehab
@ 2020-12-03 22:36 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2020-12-03 22:36 UTC (permalink / raw)
To: openrisc
On Mon, 30 Nov 2020 16:36:29 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> This series got already submitted last year:
>
> https://lore.kernel.org/lkml/cover.1561222784.git.mchehab+samsung at 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.
OK, I've gone ahead and applied these; it gains me a new trivial conflict
with x86, but so be it...
That said, I think that the RST table formatting could be *way* improved.
The current tables are all white space and hard to make sense of. What if
we condensed the information? Just looking at the first entry in
Documentation/admin-guide/features.html, perhaps it could look like:
FEATURE KCONFIG/DESCRIPTION STATUS
cBPF-JIT HAVE_CBPF_JIT TODO: alpha, arc, arm...
ok: mips, powerpc, ...
arch supports cBPF JIT
optimizations
The result would be far more compact and easy to read, IMO. I may get
around to giving this a try if (hint :) nobody else gets there first.
Thanks,
jon
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-12-03 22:36 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-11-30 15:36 [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs Mauro Carvalho Chehab
2020-11-30 15:36 ` [OpenRISC] [PATCH 6/6] docs: archis: add a per-architecture features list Mauro Carvalho Chehab
2020-12-03 22:36 ` [OpenRISC] [PATCH 0/6] Add documentation for Documentation/features at the built docs Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox