Re: [PATCH v2] Documentation/arch: Add kernel feature descriptions and arch support status under Documentation/features/

Andrew Morton
2015-05-14T19:38:39Z

> Add arch support matrices for more than 40 generic kernel features
> that need per architecture support.
>
> Each feature has its own directory under Documentation/features/feature_name/,
> and the arch-support.txt file shows its current arch porting status.
>
> For example, lockdep support is shown the following way:
>
> triton:~/tip> cat Documentation/features/lockdep/arch-support.txt
> #
> # Feature name: lockdep
> # Kconfig: LOCKDEP_SUPPORT
> # description: arch supports the runtime locking correctness debug facility
> #
> -----------------------
> | arch |status|
> -----------------------
> ...
> | xtensa: | ok |
> -----------------------
>
> For generic kernel features that need architecture support, the
> arch-support.txt file in each feature directory shows the arch
> support matrix, for all upstream Linux architectures.
>
> The meaning of entries in the tables is:
>
> | ok | # feature supported by the architecture
> |TODO| # feature not yet supported by the architecture
> | .. | # feature cannot be supported by the hardware

Presumably there will be instances where the maintainer decides "we
shall not implement that".

> This directory structure can be used in the future to add other
> files - such as porting guides, testing description, etc.

I suppose so. Having a great bunch of directories, each containing a
single file is a bit odd.

It would be nice to provide people with commit IDs to look at, but the
IDs won't be known at the time the documentation file is created. We
could provide patch titles.

But still, let's not overdo it - get something in there, see how well
it works, evolve it over time.

I don't think we've heard from any (non-x86) arch maintainers? Do they
consider this useful at all? Poke.