From: Jonathan Corbet <corbet@lwn.net>
To: Heinrich Schuchardt <xypron.glpk@gmx.de>
Cc: Ard Biesheuvel <ardb@kernel.org>, Ivan Hu <ivan.hu@canonical.com>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-efi <linux-efi@vger.kernel.org>
Subject: Re: [RFC] Documentation for /dev/efi_test
Date: Thu, 10 Dec 2020 15:58:59 -0700 [thread overview]
Message-ID: <20201210155859.5c3babee@lwn.net> (raw)
In-Reply-To: <0d27217e-15c4-32e5-0dc3-47b94116ad64@gmx.de>
On Thu, 10 Dec 2020 22:49:09 +0100
Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
> to test UEFI runtime services we have CONFIG_EFI_TEST which provides
> /dev/efi_test and a bunch of IOCTLs for excercising the runtime services
> (cf. drivers/firmware/efi/test/efi_test.h).
>
> Currently there is no user documentation for this ABI.
>
> Where should the documentation for the ABI be put in the documentation
> tree? Is this Documentation/ABI/stable/?
To date, nobody has documented ioctl() interfaces under Documentation/ABI;
this probably isn't the time to start. The best way to document it might
be to put your testing code in the tools/testing directory. You could
also add something to the userspace-api manual as well, but that might
increase your chances of being committed to maintaining that interface
forever...
Thanks,
jon
prev parent reply other threads:[~2020-12-10 23:00 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-10 21:49 [RFC] Documentation for /dev/efi_test Heinrich Schuchardt
2020-12-10 22:58 ` Jonathan Corbet [this message]
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=20201210155859.5c3babee@lwn.net \
--to=corbet@lwn.net \
--cc=ardb@kernel.org \
--cc=ivan.hu@canonical.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-efi@vger.kernel.org \
--cc=xypron.glpk@gmx.de \
/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;
as well as URLs for NNTP newsgroup(s).