[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <710149630eb010b18b69e161d02502bc3b648173.camel@HansenPartnership.com>
Date: Thu, 26 Oct 2023 07:39:44 -0400
From: James Bottomley <James.Bottomley@...senPartnership.com>
To: Christoph Hellwig <hch@....de>, Kees Cook <keescook@...omium.org>
Cc: Justin Stitt <justinstitt@...gle.com>, Keith Busch <kbusch@...nel.org>,
Jens Axboe <axboe@...nel.dk>, Sagi Grimberg <sagi@...mberg.me>,
linux-nvme@...ts.infradead.org, linux-kernel@...r.kernel.org,
linux-hardening@...r.kernel.org, ksummit@...ts.linux.dev
Subject: Re: the nul-terminated string helper desk chair rearrangement
On Thu, 2023-10-26 at 12:01 +0200, Christoph Hellwig wrote:
> > > There's some docs at [1]. Perhaps there could be more?
> > >
> > > [1]:
> > > https://elixir.bootlin.com/linux/v6.6-rc6/source/include/linux/fortify-string.h#L292
> >
> > Right, And it's even valid kern-doc, which gets rendered in the
> > kernel API docs, along with all the other string functions:
> > https://docs.kernel.org/core-api/kernel-api.html#c.strscpy
>
> Well, I never use the generated kerneldoc because it's much harder
> than just grepping the tree, but indeed it exists even if it's hidden
> in the most obsfucated way. But at least I know now!
This, honestly, is one of the really annoying problems of kerneldoc.
When looking for structures or functions
git grep "<function> -"
usually finds it. However, I recently asked on linux-scsi if we could
point to the doc about system_state and what it meant. However, either
we all suck or there's no such documentation because no-one could find
it.
While it's nice in theory to have everything documented, it's not much
use if no one can actually find the information ...
James
Powered by blists - more mailing lists