0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 Documentation subsystem maintainer entry profile
0004 ================================================
0005
0006 The documentation "subsystem" is the central coordinating point for the
0007 kernel's documentation and associated infrastructure. It covers the
0008 hierarchy under Documentation/ (with the exception of
0009 Documentation/devicetree), various utilities under scripts/ and, at least
0010 some of the time, LICENSES/.
0011
0012 It's worth noting, though, that the boundaries of this subsystem are rather
0013 fuzzier than normal. Many other subsystem maintainers like to keep control
0014 of portions of Documentation/, and many more freely apply changes there
0015 when it is convenient. Beyond that, much of the kernel's documentation is
0016 found in the source as kerneldoc comments; those are usually (but not
0017 always) maintained by the relevant subsystem maintainer.
0018
0019 The mailing list for documentation is linux-doc@vger.kernel.org. Patches
0020 should be made against the docs-next tree whenever possible.
0021
0022 Submit checklist addendum
0023 -------------------------
0024
0025 When making documentation changes, you should actually build the
0026 documentation and ensure that no new errors or warnings have been
0027 introduced. Generating HTML documents and looking at the result will help
0028 to avoid unsightly misunderstandings about how things will be rendered.
0029
0030 Key cycle dates
0031 ---------------
0032
0033 Patches can be sent anytime, but response will be slower than usual during
0034 the merge window. The docs tree tends to close late before the merge
0035 window opens, since the risk of regressions from documentation patches is
0036 low.
0037
0038 Review cadence
0039 --------------
0040
0041 I am the sole maintainer for the documentation subsystem, and I am doing
0042 the work on my own time, so the response to patches will occasionally be
0043 slow. I try to always send out a notification when a patch is merged (or
0044 when I decide that one cannot be). Do not hesitate to send a ping if you
0045 have not heard back within a week of sending a patch.
