Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: add blurb about target audience to maintainer-profile

It's good to be clear about who the intended target audience for any
given piece of documentation is, as this will help us put new text in
the correct place. Let's encourage submitters to state it explicitly
rather than relying on where they placed it in the directory hierarchy
as there isn't necessarily a one-to-one correspondence between them.

Target audience: documentation contributors and reviewers.

Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240111094838.3695697-1-vegard.nossum@oracle.com

authored by

Vegard Nossum and committed by
Jonathan Corbet
60804e58 e5a52766

+7
+7
Documentation/doc-guide/maintainer-profile.rst
··· 27 27 introduced. Generating HTML documents and looking at the result will help 28 28 to avoid unsightly misunderstandings about how things will be rendered. 29 29 30 + All new documentation (including additions to existing documents) should 31 + ideally justify who the intended target audience is somewhere in the 32 + changelog; this way, we ensure that the documentation ends up in the correct 33 + place. Some possible categories are: kernel developers (experts or 34 + beginners), userspace programmers, end users and/or system administrators, 35 + and distributors. 36 + 30 37 Key cycle dates 31 38 --------------- 32 39