maintainer-profile.rst 1.9 KB

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