Skip to content

RFC Documentation: nouveau: Introduce some nouveau documentation

Jeremy Cline nouveau 2 versions – New

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 RFC Latest3 patches 0 repliesNew
  2. v1 RFC1 patch 13 repliesSuperseded

Patches in v2 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3drm/nouveau/kms/nvd9-: Introduce some kernel-docs for CRC supportdrivers/gpu/drm/nouveau/dispnv50/crc.c drivers/gpu/drm/nouveau/dispnv50/crc.h+73 -00 replies
2/3nouveau: Add kernel-docs for module parametersdrivers/gpu/drm/nouveau/nouveau_drm.c+162 -00 replies
3/3Documentation: nouveau: Introduce some nouveau documentationDocumentation/gpu/drivers.rst Documentation/gpu/nouveau.rst+174 -00 replies

Reviews trailers per patch

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

Read the v2 thread

Cover letter [RFC PATCH v2 0/3] Documentation: nouveau: Introduce some nouveau documentation

Hi folks,

Here's a v2 of the initial nouveau documentation page.

Based on Roy Spliet's feedback, I added a pointer to envytools documentation, and attempted to clarify that this document is only about software architecture.

I also noted more clearly it was meant to compliment the nouveau freedesktop.org documentation.

Finally, for some starter documentation I dropped my vague placeholder documentation on the display engine struct and added notes on the CRC work, which I recently became more familiar with.

I've left out sub-sections for which I had no content, but you can imagine the nouveau-specific ioctls being documented in their own sub-section of the "Public API" section, or additional sub-sections to the "Private APIs" for NVKM and such.

Let me know what you think!

Jeremy Cline (3):
drm/nouveau/kms/nvd9-: Introduce some kernel-docs for CRC support
nouveau: Add kernel-docs for module parameters
Documentation: nouveau: Introduce some nouveau documentation

 Documentation/gpu/drivers.rst          |   1 +
 Documentation/gpu/nouveau.rst          | 173 +++++++++++++++++++++++++
 drivers/gpu/drm/nouveau/dispnv50/crc.c |   8 ++
 drivers/gpu/drm/nouveau/dispnv50/crc.h |  65 ++++++++++
 drivers/gpu/drm/nouveau/nouveau_drm.c  | 162 +++++++++++++++++++++++
 5 files changed, 409 insertions(+)
 create mode 100644 Documentation/gpu/nouveau.rst
Signature · 1 line
2.28.0