From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
gregkh@linuxfoundation.org, Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Borislav Petkov <bp@alien8.de>,
"H. Peter Anvin" <hpa@zytor.com>, Ingo Molnar <mingo@redhat.com>,
Thomas Gleixner <tglx@linutronix.de>,
x86@kernel.org
Subject: [PATCH 0/4] Add Documentation/features to admin-guide and x86
Date: Sat, 22 Jun 2019 14:17:03 -0300 [thread overview]
Message-ID: <cover.1561222784.git.mchehab+samsung@kernel.org> (raw)
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
--
2.21.0
next reply other threads:[~2019-06-22 17:17 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-22 17:17 Mauro Carvalho Chehab [this message]
2019-06-22 17:17 ` [PATCH 1/4] scripts/get_feat.pl: add a script to handle Documentation/features Mauro Carvalho Chehab
2019-06-22 17:17 ` [PATCH 2/4] scripts/get_feat.pl: handle ".." special case Mauro Carvalho Chehab
2019-06-22 17:17 ` [PATCH 3/4] sphinx/kernel_feat.py: add a script to parse feature files Mauro Carvalho Chehab
2019-06-22 17:17 ` [PATCH 4/4] docs: admin-guide, x86: add a features list 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.1561222784.git.mchehab+samsung@kernel.org \
--to=mchehab+samsung@kernel.org \
--cc=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=hpa@zytor.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=mingo@redhat.com \
--cc=tglx@linutronix.de \
--cc=x86@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