Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
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
Message-Id: <cover.1561222784.git.mchehab+samsung@kernel.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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