Skip to content

Commit

Permalink
Add a maintainer entry profile for documentation
Browse files Browse the repository at this point in the history
Documentation should lead by example, so here's a basic maintainer entry
profile for this subsystem.

Reviewed-by: Matthew Wilcox (Oracle) <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
Jonathan Corbet committed Jan 24, 2020
1 parent d96574b commit 53b7f3a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/doc-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ How to write kernel documentation
kernel-doc
parse-headers
contributing
maintainer-profile

.. only:: subproject and html

Expand Down
44 changes: 44 additions & 0 deletions Documentation/doc-guide/maintainer-profile.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. SPDX-License-Identifier: GPL-2.0
Documentation subsystem maintainer entry profile
================================================

The documentation "subsystem" is the central coordinating point for the
kernel's documentation and associated infrastructure. It covers the
hierarchy under Documentation/ (with the exception of
Documentation/device-tree), various utilities under scripts/ and, at least
some of the time, LICENSES/.

It's worth noting, though, that the boundaries of this subsystem are rather
fuzzier than normal. Many other subsystem maintainers like to keep control
of portions of Documentation/, and many more freely apply changes there
when it is convenient. Beyond that, much of the kernel's documentation is
found in the source as kerneldoc comments; those are usually (but not
always) maintained by the relevant subsystem maintainer.

The mailing list for documentation is [email protected]. Patches
should be made against the docs-next tree whenever possible.

Submit checklist addendum
-------------------------

When making documentation changes, you should actually build the
documentation and ensure that no new errors or warnings have been
introduced. Generating HTML documents and looking at the result will help
to avoid unsightly misunderstandings about how things will be rendered.

Key cycle dates
---------------

Patches can be sent anytime, but response will be slower than usual during
the merge window. The docs tree tends to close late before the merge
window opens, since the risk of regressions from documentation patches is
low.

Review cadence
--------------

I am the sole maintainer for the documentation subsystem, and I am doing
the work on my own time, so the response to patches will occasionally be
slow. I try to always send out a notification when a patch is merged (or
when I decide that one cannot be). Do not hesitate to send a ping if you
have not heard back within a week of sending a patch.
1 change: 1 addition & 0 deletions Documentation/maintainer/maintainer-entry-profile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,5 @@ to do something different in the near future.
.. toctree::
:maxdepth: 1

../doc-guide/maintainer-profile
../nvdimm/maintainer-entry-profile

0 comments on commit 53b7f3a

Please sign in to comment.