1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0 2*4882a593Smuzhiyun 3*4882a593SmuzhiyunDocumentation subsystem maintainer entry profile 4*4882a593Smuzhiyun================================================ 5*4882a593Smuzhiyun 6*4882a593SmuzhiyunThe documentation "subsystem" is the central coordinating point for the 7*4882a593Smuzhiyunkernel's documentation and associated infrastructure. It covers the 8*4882a593Smuzhiyunhierarchy under Documentation/ (with the exception of 9*4882a593SmuzhiyunDocumentation/devicetree), various utilities under scripts/ and, at least 10*4882a593Smuzhiyunsome of the time, LICENSES/. 11*4882a593Smuzhiyun 12*4882a593SmuzhiyunIt's worth noting, though, that the boundaries of this subsystem are rather 13*4882a593Smuzhiyunfuzzier than normal. Many other subsystem maintainers like to keep control 14*4882a593Smuzhiyunof portions of Documentation/, and many more freely apply changes there 15*4882a593Smuzhiyunwhen it is convenient. Beyond that, much of the kernel's documentation is 16*4882a593Smuzhiyunfound in the source as kerneldoc comments; those are usually (but not 17*4882a593Smuzhiyunalways) maintained by the relevant subsystem maintainer. 18*4882a593Smuzhiyun 19*4882a593SmuzhiyunThe mailing list for documentation is linux-doc@vger.kernel.org. Patches 20*4882a593Smuzhiyunshould be made against the docs-next tree whenever possible. 21*4882a593Smuzhiyun 22*4882a593SmuzhiyunSubmit checklist addendum 23*4882a593Smuzhiyun------------------------- 24*4882a593Smuzhiyun 25*4882a593SmuzhiyunWhen making documentation changes, you should actually build the 26*4882a593Smuzhiyundocumentation and ensure that no new errors or warnings have been 27*4882a593Smuzhiyunintroduced. Generating HTML documents and looking at the result will help 28*4882a593Smuzhiyunto avoid unsightly misunderstandings about how things will be rendered. 29*4882a593Smuzhiyun 30*4882a593SmuzhiyunKey cycle dates 31*4882a593Smuzhiyun--------------- 32*4882a593Smuzhiyun 33*4882a593SmuzhiyunPatches can be sent anytime, but response will be slower than usual during 34*4882a593Smuzhiyunthe merge window. The docs tree tends to close late before the merge 35*4882a593Smuzhiyunwindow opens, since the risk of regressions from documentation patches is 36*4882a593Smuzhiyunlow. 37*4882a593Smuzhiyun 38*4882a593SmuzhiyunReview cadence 39*4882a593Smuzhiyun-------------- 40*4882a593Smuzhiyun 41*4882a593SmuzhiyunI am the sole maintainer for the documentation subsystem, and I am doing 42*4882a593Smuzhiyunthe work on my own time, so the response to patches will occasionally be 43*4882a593Smuzhiyunslow. I try to always send out a notification when a patch is merged (or 44*4882a593Smuzhiyunwhen I decide that one cannot be). Do not hesitate to send a ping if you 45*4882a593Smuzhiyunhave not heard back within a week of sending a patch. 46