Skip to contentSkip to conversation

Documentation/process: add soc maintainer handbook

PATCH Applied Conor Dooley 5 participants 5 messages Jun 6, 2023 – Jun 17, 2023

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 Documentation/process: add soc maintainer handbook

Arnd suggested that adding a maintainer handbook for the SoC "subsystem" would be helpful in trying to bring on board maintainers for the various new platforms cropping up in RISC-V land.

Add a document briefly describing the role of the SoC subsystem and some basic advice for (new) platform maintainers.

---
Changes in v3:
- sort out a rake of spelling/grammar bits spotted by Randy, apart from the one noted as a suggestion
- drop the refs for document filepaths

Changes in v2:
- add Krzysztof's suggested method for avoiding inter-branch dependencies
- explicitly mention that tags should be signed
- link to the devicetree abi document, rather than trying to explain it here & reword that whole section
- fix some typos, capitalisation & unify bullet style

The devicetree abi doc feels quite out of date at this point, and could probably do with a spring clean - but it also feels like hallowed ground on which one should tread lightly, so I won't go near that til Rob is back.

---
 .../process/maintainer-handbooks.rst          |   3 +-
 Documentation/process/maintainer-soc.rst      | 177 ++++++++++++++++++
 MAINTAINERS                                   |   1 +
 3 files changed, 180 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/process/maintainer-soc.rst
Documentation/process/maintainer-handbooks.rst +2 -1
index d783060b4cc6..fe24cb665fb7 100644
@@ -15,5 +15,6 @@ Contents:
    :numbered:
    :maxdepth: 2
 
-   maintainer-tip
    maintainer-netdev
+   maintainer-soc
+   maintainer-tip
Documentation/process/maintainer-soc.rst new file +177 -0

177 lines not on this page · raw message

MAINTAINERS +1 -0
index 7e0b87d5aa2e..29631c325857 100644
@@ -1815,6 +1815,7 @@ L:	[email protected] (moderated for non-subscribers)
 S:	Maintained
 C:	irc://irc.libera.chat/armlinux
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc.git
+F:	Documentation/process/maintainer-soc.rst
 F:	arch/arm/boot/dts/Makefile
 F:	arch/arm64/boot/dts/Makefile
 
Signature · 1 line
2.40.1
maintainer
#1 lore raw
Quoted 7 lines · Conor Dooley

Arnd suggested that adding a maintainer handbook for the SoC "subsystem" would be helpful in trying to bring on board maintainers for the various new platforms cropping up in RISC-V land.

Add a document briefly describing the role of the SoC subsystem and some basic advice for (new) platform maintainers.

Quoted 8 lines

---
Changes in v3:
- sort out a rake of spelling/grammar bits spotted by Randy, apart from the one noted as a suggestion
- drop the refs for document filepaths

Thanks, I've applied this in the soc/newsoc branch of the soc tree now, which is where I'm already queuing new platforms.

Arnd

#2 lore raw

Hey Arnd,

Quoted 17 lines · Arnd Bergmann
Quoted 7 lines · Conor Dooley

Arnd suggested that adding a maintainer handbook for the SoC "subsystem" would be helpful in trying to bring on board maintainers for the various new platforms cropping up in RISC-V land.

Add a document briefly describing the role of the SoC subsystem and some basic advice for (new) platform maintainers.

Quoted 8 lines

---
Changes in v3:
- sort out a rake of spelling/grammar bits spotted by Randy, apart from the one noted as a suggestion
- drop the refs for document filepaths

Quoted 2 lines

Thanks, I've applied this in the soc/newsoc branch of the soc tree now, which is where I'm already queuing new platforms.

Having cited this document for the first time, it came to mind that I never mentioned putting the submaintainer trees into linux-next. Should I send a follow-up patch for that, or do you think that that isn't needed?

Cheers,
Conor.

#3 lore raw
Quoted 20 lines · Conor Dooley

Hey Arnd,

Quoted 17 lines · Arnd Bergmann
Quoted 15 lines · Conor Dooley

Arnd suggested that adding a maintainer handbook for the SoC "subsystem" would be helpful in trying to bring on board maintainers for the various new platforms cropping up in RISC-V land.

Add a document briefly describing the role of the SoC subsystem and some basic advice for (new) platform maintainers.

---
Changes in v3:
- sort out a rake of spelling/grammar bits spotted by Randy, apart from the one noted as a suggestion
- drop the refs for document filepaths

Quoted 6 lines
Quoted 2 lines

Thanks, I've applied this in the soc/newsoc branch of the soc tree now, which is where I'm already queuing new platforms.

Having cited this document for the first time, it came to mind that I never mentioned putting the submaintainer trees into linux-next. Should I send a follow-up patch for that, or do you think that that isn't

This is common maintainer stuff, so every maintainer - not only SoC related - should ensure his tree is in next. I would trim all such common things from the document and store it somewhere else, because otherwise people will just not read it.

Best regards,
Krzysztof

#4 lore raw
In reply to Conor Dooley
This patch was applied to soc/soc.git (for-next) by Arnd Bergmann <[email protected]>:

Hello:

This patch was applied to soc/soc.git (for-next)
by Arnd Bergmann <[email protected]>:

Quoted 8 lines · On Tue, 6 Jun 2023 09:27:43 +0100 you wrote:

Arnd suggested that adding a maintainer handbook for the SoC "subsystem" would be helpful in trying to bring on board maintainers for the various new platforms cropping up in RISC-V land.

Add a document briefly describing the role of the SoC subsystem and some basic advice for (new) platform maintainers.

[...]

Here is the summary with links:
- [v3] Documentation/process: add soc maintainer handbook

    https://git.kernel.org/soc/soc/c/425d827ef91e

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html