|
| 1 | +.. SPDX-License-Identifier: GPL-2.0 |
| 2 | +Documentation subsystem maintainer entry profile |
| 3 | +================================================ |
| 4 | + |
| 5 | +The documentation "subsystem" is the central coordinating point for the |
| 6 | +kernel's documentation and associated infrastructure. It covers the |
| 7 | +hierarchy under Documentation/ (with the exception of |
| 8 | +Documentation/device-tree), various utilities under scripts/ and, at least |
| 9 | +some of the time, LICENSES/. |
| 10 | + |
| 11 | +It's worth noting, though, that the boundaries of this subsystem are rather |
| 12 | +fuzzier than normal. Many other subsystem maintainers like to keep control |
| 13 | +of portions of Documentation/, and many more freely apply changes there |
| 14 | +when it is convenient. Beyond that, much of the kernel's documentation is |
| 15 | +found in the source as kerneldoc comments; those are usually (but not |
| 16 | +always) maintained by the relevant subsystem maintainer. |
| 17 | + |
| 18 | +The mailing list for documentation is [email protected]. Patches |
| 19 | +should be made against the docs-next tree whenever possible. |
| 20 | + |
| 21 | +Submit checklist addendum |
| 22 | +------------------------- |
| 23 | + |
| 24 | +When making documentation changes, you should actually build the |
| 25 | +documentation and ensure that no new errors or warnings have been |
| 26 | +introduced. Generating HTML documents and looking at the result will help |
| 27 | +to avoid unsightly misunderstandings about how things will be rendered. |
| 28 | + |
| 29 | +Key cycle dates |
| 30 | +--------------- |
| 31 | + |
| 32 | +Patches can be sent anytime, but response will be slower than usual during |
| 33 | +the merge window. The docs tree tends to close late before the merge |
| 34 | +window opens, since the risk of regressions from documentation patches is |
| 35 | +low. |
| 36 | + |
| 37 | +Review cadence |
| 38 | +-------------- |
| 39 | + |
| 40 | +I am the sole maintainer for the documentation subsystem, and I am doing |
| 41 | +the work on my own time, so the response to patches will occasionally be |
| 42 | +slow. I try to always send out a notification when a patch is merged (or |
| 43 | +when I decide that one cannot be). Do not hesitate to send a ping if you |
| 44 | +have not heard back within a week of sending a patch. |
0 commit comments