Skip to content

regulator: kerneldoc cleanups

Mark Brown lkml 1 version Applied

Status from this message: Applied.

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 1 replyApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/5regulator: Remove extraneous kerneldoc annotationsdrivers/regulator/core.c+2 -20 replies
2/5regulator: Clean up kerneldoc warningsdrivers/regulator/core.c include/linux/regulator/consumer.h+26 -260 replies
3/5regulator: Add missing kerneldocdrivers/regulator/core.c include/linux/regulator/driver.h include/linux/regulator/machine.h+81 -10 replies
4/5regulator: Fix some kerneldoc rendering issuesdrivers/regulator/core.c+11 -70 replies
5/5regulator: Add basic DocBook manualDocumentation/DocBook/Makefile Documentation/DocBook/regulator.tmpl+305 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/5] regulator: kerneldoc cleanups

This patch series cleans up the kerneldoc for the regulator API and adds a brief DocBook manual for it, based heavily on the existing plain text documentation but much less complete. I'm not sure that the manual itself is actually worthwhile, the main benefit from it is the generated documentation rather than the text in the manual itself - I did the work to help with generating the earlier fixes.

It may be worth considering the first four patches for 2.6.29 as fixes, though it's questionable.

The following changes since commit b6fe1c783638104350147877f5823d8faa68f6a2:
David Brownell (1):
regulator: init/link earlier

are available in the git repository at:

git://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator-2.6.git topic/doc

Mark Brown (5):
regulator: Remove extraneous kerneldoc annotations
regulator: Clean up kerneldoc warnings
regulator: Add missing kerneldoc
regulator: Fix some kerneldoc rendering issues
regulator: Add basic DocBook manual

 Documentation/DocBook/Makefile       |    2 +-
 Documentation/DocBook/regulator.tmpl |  304 ++++++++++++++++++++++++++++++++++
 drivers/regulator/core.c             |   57 ++++---
 include/linux/regulator/consumer.h   |    8 +-
 include/linux/regulator/driver.h     |   40 +++++-
 include/linux/regulator/machine.h    |   41 +++++
 6 files changed, 420 insertions(+), 32 deletions(-)
 create mode 100644 Documentation/DocBook/regulator.tmpl