Skip to contentSkip to conversation

Documentation: add a driver API doc for the power sequencing subsystem

PATCH Applied Bartosz Golaszewski 2 participants 3 messages Aug 21, 2024 – Aug 22, 2024

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

PATCH v2 1/1 Documentation: add a driver API doc for the power sequencing subsystem

From: Bartosz Golaszewski <[email protected]>

Describe what the subsystem does, how the consumers and providers work and add API reference generated from kerneldocs.

---
Changes since v1:
- drop unneeded :c:func: directives
- don't include linux/pwrseq/consumer.h as there are no kerneldocs in it which results in a sphinx warning

 Documentation/driver-api/index.rst  |  1 +
 Documentation/driver-api/pwrseq.rst | 95 +++++++++++++++++++++++++++++
 MAINTAINERS                         |  1 +
 3 files changed, 97 insertions(+)
 create mode 100644 Documentation/driver-api/pwrseq.rst
Documentation/driver-api/index.rst +1 -0
index f10decc2c14b6..7f83e05769b4a 100644
@@ -124,6 +124,7 @@ Subsystem-specific APIs
    pps
    ptp
    pwm
+   pwrseq
    regulator
    reset
    rfkill
Documentation/driver-api/pwrseq.rst new file +95 -0

95 lines not on this page · raw message

MAINTAINERS +1 -0
index a7cb909ffa1d6..6da6d8ae951a1 100644
@@ -18315,6 +18315,7 @@ M:	Bartosz Golaszewski <[email protected]>
 L:	[email protected]
 S:	Maintained
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/brgl/linux.git
+F:	Documentation/driver-api/pwrseq.rst
 F:	drivers/power/sequencing/
 F:	include/linux/pwrseq/
 
Signature · 1 line
2.43.0
maintainer Acked-by on v2 1/1
#1 lore raw
Quoted 12 lines · Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

Describe what the subsystem does, how the consumers and providers work and add API reference generated from kerneldocs.

---
Changes since v1:
- drop unneeded :c:func: directives
- don't include linux/pwrseq/consumer.h as there are no kerneldocs in it which results in a sphinx warning

Quoted 5 lines
 Documentation/driver-api/index.rst  |  1 +
 Documentation/driver-api/pwrseq.rst | 95 +++++++++++++++++++++++++++++
 MAINTAINERS                         |  1 +
 3 files changed, 97 insertions(+)
 create mode 100644 Documentation/driver-api/pwrseq.rst

Looks good to me, thanks.

jon

author Applied
#2 lore raw
In reply to Bartosz Golaszewski

From: Bartosz Golaszewski <[email protected]>

Quoted 4 lines · Bartosz Golaszewski

Describe what the subsystem does, how the consumers and providers work and add API reference generated from kerneldocs.

Applied, thanks!

[1/1] Documentation: add a driver API doc for the power sequencing subsystem

      commit: 8b7e0a6c443e855374a426dcdfd0a19912d70df3

Best regards,

Signature · 1 line
Bartosz Golaszewski <[email protected]>