linux-kernel - Re: [PATCH] Documentation: Destage TEE subsystem documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <0de17ec7-b692-4d1e-b059-c5f3f619e94a@oracle.com>
Date:   Tue, 31 Oct 2023 11:16:21 +0100
From:   Vegard Nossum <vegard.nossum@...cle.com>
To:     Sumit Garg <sumit.garg@...aro.org>, corbet@....net,
        jens.wiklander@...aro.org
Cc:     Rijo-john.Thomas@....com, balint.dobszay@....com,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        op-tee@...ts.trustedfirmware.org
Subject: Re: [PATCH] Documentation: Destage TEE subsystem documentation


On 31/10/2023 11:07, Sumit Garg wrote:
> Add a separate documentation directory for TEE subsystem since it is a
> standalone subsystem which already offers devices consumed by multiple
> different subsystem drivers.
> 
> Split overall TEE subsystem documentation modularly where the first
> module covers the overview of TEE subsystem itself along with generic
> features. Then the further modules are dedicated to different TEE
> implementations like:
> - OP-TEE
> - AMD-TEE
> - and so on for future TEE implementation support.
> 
> Signed-off-by: Sumit Garg <sumit.garg@...aro.org>
> ---
>   Documentation/staging/index.rst  |   1 -
>   Documentation/staging/tee.rst    | 364 -------------------------------
>   Documentation/subsystem-apis.rst |   1 +
>   Documentation/tee/amd-tee.rst    |  90 ++++++++
>   Documentation/tee/index.rst      |  19 ++
>   Documentation/tee/op-tee.rst     | 166 ++++++++++++++
>   Documentation/tee/tee.rst        | 122 +++++++++++
>   MAINTAINERS                      |   2 +-
>   8 files changed, 399 insertions(+), 366 deletions(-)
>   delete mode 100644 Documentation/staging/tee.rst
>   create mode 100644 Documentation/tee/amd-tee.rst
>   create mode 100644 Documentation/tee/index.rst
>   create mode 100644 Documentation/tee/op-tee.rst
>   create mode 100644 Documentation/tee/tee.rst

A comment from the peanut gallery:

The old tee.rst starts out describing the userspace API (include/uapi/,
/dev/tee, etc.). Maybe this part should go into
Documentation/userspace-api/.

The rest of the document describes the internal kernel API (how to write
a TEE driver). And maybe this part should go into Documentation/driver-api/.

At least I think that kind of split is what the documentation is going
for in the long term, so if you're moving these files around anyway it
might make sense to do it right away.


Vegard