04 Sep, 2020
1 commit
-
The repeated sign-offs necessary when a subsystem maintainer modifies an
incoming patch has been moved from submitting-patches.rst to
Documentation/maintainer, since the affairs of a subsystem maintainer
are not especially relevant to someone reading a guide for how to submit
their first patch.Signed-off-by: Drew DeVault
Link: https://lore.kernel.org/r/20200903160545.83185-4-sir@cmpwn.com
Signed-off-by: Jonathan Corbet
25 Aug, 2020
1 commit
-
As long as there are only a few maintainer entry profiles, i.e., three
in v5.8, continue to maintain a complete a list of entries in the
maintainer handbook.Complete the list by adding the RISC-V ARCHITECTURE maintainer entry
profile found in MAINTAINERS.Signed-off-by: Lukas Bulwahn
Link: https://lore.kernel.org/r/20200815115728.15128-1-lukas.bulwahn@gmail.com
Signed-off-by: Jonathan Corbet
13 Jul, 2020
1 commit
-
Drop the doubled word "have".
Signed-off-by: Randy Dunlap
Cc: Jonathan Corbet
Cc: linux-doc@vger.kernel.org
Cc: Dan Williams
Link: https://lore.kernel.org/r/20200707180414.10467-13-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet
01 Jun, 2020
1 commit
-
Do some wordsmithing and copy editing on the maintainer-entry-profile
profile (template, guide):
- fix punctuation
- fix some wording
- use "-rc" consistentlySigned-off-by: Randy Dunlap
Cc: Dan Williams
Cc: linux-nvdimm@lists.01.org
Cc: Jonathan Corbet
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/fbaa9b67-e7b8-d5e8-ecbb-6ae068234880@infradead.org
Signed-off-by: Jonathan Corbet
25 Jan, 2020
1 commit
-
Documentation should lead by example, so here's a basic maintainer entry
profile for this subsystem.Reviewed-by: Matthew Wilcox (Oracle)
Signed-off-by: Jonathan Corbet
25 Nov, 2019
2 commits
-
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
-
As presented at the 2018 Linux Plumbers conference [1], the Maintainer
Entry Profile (formerly Subsystem Profile) is proposed as a way to reduce
friction between committers and maintainers and encourage conversations
amongst maintainers about common best practices. While coding-style,
submit-checklist, and submitting-drivers lay out some common expectations
there remain local customs and maintainer preferences that vary by
subsystem.The profile contains documentation of some of the common policy
questions a contributor might have that are local to the subsystem /
device-driver, special considerations for the subsystem, or other
guidelines that are otherwise not covered by the top-level process
documents.The initial and hopefully non-controversial headings in the profile are:
Overview:
General introduction to how the subsystem operatesSubmit Checklist Addendum:
Mechanical items that gate submission staging, or other requirements
that gate patch acceptance.Key Cycle Dates:
- Last -rc for new feature submissions: Expected lead time for submissions
- Last -rc to merge features: Deadline for merge decisionsResubmit Cadence: When and preferred method to follow up with the
maintainerNote that coding style guidelines are explicitly left out of this list.
See Documentation/maintainer/maintainer-entry-profile.rst for more details,
and a follow-on example profile for the libnvdimm subsystem.[1]: https://linuxplumbersconf.org/event/2/contributions/59/
Cc: Jonathan Corbet
Cc: Thomas Gleixner
Cc: Mauro Carvalho Chehab
Cc: Steve French
Cc: Greg Kroah-Hartman
Cc: Linus Torvalds
Cc: Tobin C. Harding
Cc: Olof Johansson
Cc: Martin K. Petersen
Cc: Daniel Vetter
Cc: Joe Perches
Cc: Dmitry Vyukov
Cc: Alexandre Belloni
Cc: Paul Walmsley
Signed-off-by: Dan Williams
Link: https://lore.kernel.org/r/157462919309.1729495.10585699280061787229.stgit@dwillia2-desk3.amr.corp.intel.com
Signed-off-by: Jonathan Corbet
20 Nov, 2019
1 commit
-
This adds Kees' clever apply hook to the kernel documentation so
it can be easily references when needed.Cc: Kees Cook
Link: https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2019-July/006608.html
Signed-off-by: Linus Walleij
Link: https://lore.kernel.org/r/20191118223019.81708-1-linus.walleij@linaro.org
Signed-off-by: Jonathan Corbet
13 Aug, 2019
1 commit
-
Signed-off-by: Marco Villegas
Signed-off-by: Jonathan Corbet
17 Jul, 2019
1 commit
-
Now that the latex_documents are handled automatically, we can
remove those extra conf.py files.Signed-off-by: Mauro Carvalho Chehab
18 Jun, 2019
1 commit
-
Every merge window seems to involve at least one episode where subsystem
maintainers don't manage their trees as Linus would like. Document the
expectations so that at least he has something to point people to.Acked-by: David Rientjes
Signed-off-by: Jonathan Corbet
16 Jun, 2018
1 commit
-
As we move stuff around, some doc references are broken. Fix some of
them via this script:
./scripts/documentation-file-ref-check --fixManually checked that produced results are valid.
Acked-by: Matthias Brugger
Acked-by: Takashi Iwai
Acked-by: Jeff Kirsher
Acked-by: Guenter Roeck
Acked-by: Miguel Ojeda
Signed-off-by: Mauro Carvalho Chehab
Acked-by: Jonathan Corbet
12 Dec, 2017
2 commits
-
...just enough to say what the purpose is and to solicit more
contributions.Signed-off-by: Jonathan Corbet
-
There is currently very little documentation in the kernel on maintainer
level tasks. In particular there are no documents on creating pull
requests to submit to Linus.Quoting Greg Kroah-Hartman on LKML:
Anyway, this actually came up at the kernel summit / maintainer
meeting a few weeks ago, in that "how do I make a
good pull request to Linus" is something we need to document.Here's what I do, and it seems to work well, so maybe we should turn
it into the start of the documentation for how to do it.(quote references: kernel summit, Europe 2017)
Create a new kernel documentation book 'how to be a maintainer'
(suggested by Jonathan Corbet). Add chapters on 'configuring git' and
'creating a pull request'.Most of the content was written by Linus Torvalds and Greg Kroah-Hartman
in discussion on LKML. This is stated at the start of one of the
chapters and the original email thread is referenced in
'pull-requests.rst'.Signed-off-by: Tobin C. Harding
Reviewed-by: Greg Kroah-Hartman
Reviewed-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet