summaryrefslogtreecommitdiffstats
path: root/Documentation/maintainer
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2019-11-25 08:42:12 -0700
committerJonathan Corbet <corbet@lwn.net>2019-11-25 08:42:12 -0700
commit0bfa52a43ec085c2f5eb2c35fcc6cf73bb802eae (patch)
tree00b1b89c35f721fb3e7bb2578a54cf90c9755603 /Documentation/maintainer
parent47843401e3a0f4f668927b77e713c876bb423d4f (diff)
downloadlinux-0bfa52a43ec085c2f5eb2c35fcc6cf73bb802eae.tar.gz
linux-0bfa52a43ec085c2f5eb2c35fcc6cf73bb802eae.tar.bz2
linux-0bfa52a43ec085c2f5eb2c35fcc6cf73bb802eae.zip
docs: fix up the maintainer profile document
Add blank lines where needed to get the document to render properly. Also add a TOC of existing profiles just so that the nvdimm profile is linked into the toctree, is discoverable, and doesn't generate a warning. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/maintainer')
-rw-r--r--Documentation/maintainer/maintainer-entry-profile.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
index 51de3b9e606d..3eaddc8ac56d 100644
--- a/Documentation/maintainer/maintainer-entry-profile.rst
+++ b/Documentation/maintainer/maintainer-entry-profile.rst
@@ -18,7 +18,9 @@ Provide an introduction to how the subsystem operates. While MAINTAINERS
tells the contributor where to send patches for which files, it does not
convey other subsystem-local infrastructure and mechanisms that aid
development.
+
Example questions to consider:
+
- Are there notifications when patches are applied to the local tree, or
merged upstream?
- Does the subsystem have a patchwork instance? Are patchwork state
@@ -55,6 +57,7 @@ be settled in soaking in linux-next in advance of the merge window
opening. Clarify for the submitter the key dates (in terms rc release
week) that patches might considered for merging and when patches need to
wait for the next -rc. At a minimum:
+
- Last -rc for new feature submissions:
New feature submissions targeting the next merge window should have
their first posting for consideration before this point. Patches that
@@ -72,6 +75,7 @@ wait for the next -rc. At a minimum:
resubmit for the following merge window.
Optional:
+
- First -rc at which the development baseline branch, listed in the
overview section, should be considered ready for new submissions.
@@ -85,3 +89,14 @@ section can also indicate a preferred style of update like, resend the
full series, or privately send a reminder email. This section might also
list how review works for this code area and methods to get feedback
that are not directly from the maintainer.
+
+Existing profiles
+-----------------
+
+For now, existing maintainer profiles are listed here; we will likely want
+to do something different in the near future.
+
+.. toctree::
+ :maxdepth: 1
+
+ ../nvdimm/maintainer-entry-profile