Re: [PATCH 10/14] docs: move locking-specific documenta to locking/ directory

[Mauro Carvalho Chehab]

Em Fri, 15 May 2020 12:06:07 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> On Fri,  1 May 2020 17:37:54 +0200
> Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote:
> 
> > Several files under Documentation/*.txt describe some type of
> > locking API. Move them to locking/ subdir and add to the
> > locking/index.rst index file.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>  
> 
> I've applied this, but it really seems like this belongs in the core-api
> manual someday.

Makes sense.

Well, right now, it is at the same level as core-api, just below it:

	Kernel API documentation
	------------------------

	These books get into the details of how specific kernel subsystems work
	from the point of view of a kernel developer.  Much of the information here
	is taken directly from the kernel source, with supplemental material added
	as needed (or at least as we managed to add it â probably *not* all that is
	needed).
	
	.. toctree::
	   :maxdepth: 2
	
	   driver-api/index
	   core-api/index
	   locking/index

Not too bad.

Btw, there are other doc sets that could also fit into the core-api, like:

	...
	   accounting/index
	...
	   security/index
	...
	   bpf/index
	...
	   scheduler/index

while most of the rest should likely be inside driver-api.

Some care should be taken when moving stuff, though: there is a
reason why they weren't moved to driver-api in the first place:
they may contain stuff for the admin guide mixed there.

Thanks,
Mauro