Orange Pi5 kernel

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