Re: [PATCH 3/3] Documentation: Add real-time

[Sebastian Andrzej Siewior <bigeasy@linutronix.de>]

On 2025-07-15 14:29:42 [-0600], Jonathan Corbet wrote:
> So overall it looks good, but I do have one overriding question:
> 
> - Who is the audience for this documentation?
> 
> I think it's an important question to ask, because something this easily
> becomes an unorganized pile of stuff that somebody thought should be
> written down somewhere - better than nothing, but hard for readers to
> use effectively.
> 
> A good first step would be to supply a paragraph or two in the new
> Documentation/real-time/index.rst describing the nature of the
> documentation and who it is intended for.

The main audience are kernel developers.

> Then ... think about whether a new top-level directory under
> Documentation makes sense.  I've been working for years to reduce those,
> so I tend to push back a little when new ones show up.
> 
> - Is this documentation for kernel developers in general, with the idea
>   of maybe helping them to not break PREEMPT_RT so often?  Then perhaps
>   documentation with that focus under core-api/ makes sense.
> 
> - Is it, instead, intended as overall design documentation?  We don't
>   really have a good place for that now, maybe we need a new design/
>   book to gather such material.
> 
> See what I'm getting at?  I'm not saying that these docs *have* to go
> somewhere else, but I do think it's worth thinking about.

While thinking about it I moved it to core-api. There might some user
bits which in terms of setup which might fit under admin-guide.

> Thanks,
> 
> jon

Sebastian