converting Documentation/security/* to .rst

[Daniel Vetter]

On Wed, May 3, 2017 at 11:42 PM, Jonathan Corbet <corbet at lwn.net> wrote:
> On Mon, 1 May 2017 09:31:55 -0700
> Kees Cook <keescook at google.com> wrote:
>
>> > The real question would be one of organization.  Most of the security
>> > stuff looks like it properly belongs in the admin guide, but that's not
>> > universally the case.
>>
>> Are the index area "purposes" documented anywhere? The admin guide
>> seems to cover things outside of "administration" (like reporting
>> security bugs, which is a developer/researcher activity usually),
>> There's already a top-level "security documentation" with some TPM
>> stuff in it.
>
> They aren't really documented beyond what they, themselves, contain.  What
> you're seeing is the beginning of an effort to bring some order to the
> Documentation/ mess.  One of the biggest problems, IMO, is the lack of any
> sort of audience targeting.  We have lots of different kinds of people
> reading (we hope!) the docs, and they have to wade through a lot of
> irrelevant stuff.
>
> So we've set up guides for administrators, for kernel developers, and for
> user-space developers (the last just landing in 4.12).  There will never be
> a perfect spot for every document, but I hope we can create something
> that's more useful in the end.

Uuuhh... we might have torpedoed your efforts already in
Documenation/gpu/ Almost everything in there is for kernel developers
(gpu driver developers specifically), except we started to document
certain quirks and issues about the drm uapi in
Documentation/gpu/drm-uapi.rst. Much of that is again aimed at driver
developers (they need to implement the semantics correctly after all),
but it's also useful for userspace developers. And it might grow in
the future to include more.

How should we organize this? I admit that I'd like to keep it in
Documentation/gpu/ (because it is primarily aimed at kernel devs), but
at least linking it somewhere else might be useful?
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html