Skip to content

Add Documentation/features to admin-guide and x86

Mauro Carvalho Chehab linux-doc lkml 1 version New

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest4 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4scripts/get_feat.pl: add a script to handle Documentation/featuresscripts/get_feat.pl+472 -00 replies
2/4scripts/get_feat.pl: handle ".." special casescripts/get_feat.pl+2 -00 replies
3/4sphinx/kernel_feat.py: add a script to parse feature filesDocumentation/sphinx/kernel_feat.py+169 -00 replies
4/4docs: admin-guide, x86: add a features listDocumentation/admin-guide/features.rst Documentation/admin-guide/index.rst Documentation/conf.py +2 more+9 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/4] Add Documentation/features to admin-guide and x86

Jon, Greg & all:

Not sure what tree this would fit better.

The first 2 patches on this series reimplement the logic at:

Documentation/features/list-arch.sh

I opted to not remove the old script, as someone could depend on its specific format. The new script does the same with:

./scripts/get_feat.pl current

The difference is that it outputs with using ascii table artwork.

The way it works is that it parse all feature files and produce 3 different types of contents, depending on its arguments:

- a feature x arch matrix:

./scripts/get_feat.pl rest

- a per-architecture feature table:

	./scripts/get_feat.pl current
		or
	./scripts/get_feat.pl rest --arch=arm64

- a per-feature table:

	 ./scripts/get_feat.pl rest --feat=perf-regs

All outputs are compatible with the ReST format.

Patch 3 adds a new Sphinx plugin with handles its output.

Patch 4 adds the feature x arch matrix at the admin-guide.

Patch 4 also adds the features supported on x86 at the x86 arch guide.

IMHO, it makes sense to have a similar table on all other architectures, but the best is to wait for the next Kernel version, in order to see what arch conversion files got included.

So far, I didn't add the per-feature table anywhere.

Mauro Carvalho Chehab (4):
scripts/get_feat.pl: add a script to handle Documentation/features scripts/get_feat.pl: handle ".." special case sphinx/kernel_feat.py: add a script to parse feature files
docs: admin-guide, x86: add a features list

 Documentation/admin-guide/features.rst |   3 +
 Documentation/admin-guide/index.rst    |   1 +
 Documentation/conf.py                  |   2 +-
 Documentation/sphinx/kernel_feat.py    | 169 +++++++++
 Documentation/x86/features.rst         |   3 +
 Documentation/x86/index.rst            |   1 +
 scripts/get_feat.pl                    | 474 +++++++++++++++++++++++++
 7 files changed, 652 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/admin-guide/features.rst
 create mode 100644 Documentation/sphinx/kernel_feat.py
 create mode 100644 Documentation/x86/features.rst
 create mode 100755 scripts/get_feat.pl
Signature · 1 line
2.21.0