All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jeremy Cline <jcline-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
To: Ben Skeggs <bskeggs-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
Cc: nouveau-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org
Subject: [RFC PATCH v2 0/3] Documentation: nouveau: Introduce some nouveau documentation
Date: Tue,  6 Oct 2020 17:13:10 -0400	[thread overview]
Message-ID: <20201006211313.49177-1-jcline@redhat.com> (raw)
In-Reply-To: <20200911162128.405604-1-jcline-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>

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

-- 
2.28.0

  parent reply	other threads:[~2020-10-06 21:13 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-11 16:21 [RFC] Documentation: nouveau: Introduce some nouveau documentation Jeremy Cline
     [not found] ` <20200911162128.405604-1-jcline-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2020-09-23 19:02   ` Karol Herbst
     [not found]     ` <CACO55tsspNbYBYdNH-zd_TeZo02yY9AtJot4FW8SYEZPuKjkZA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2020-09-23 20:39       ` Jeremy Cline
2020-09-23 21:36         ` Karol Herbst
     [not found]           ` <CACO55ttM+wmbcYz6h5qeEb9_Ta=JcnRzURFYu3-9GJPMHzdFeg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2020-09-24 12:56             ` Roy Spliet
     [not found]               ` <c04d84e2-9091-a22c-c3e4-e43e4ee72057-NQbd8FSOZ1kdnm+yROfE0A@public.gmane.org>
2020-09-24 14:29                 ` Ilia Mirkin
2020-09-24 15:21                 ` Karol Herbst
     [not found]                   ` <CACO55tvM557nS=5u-QVtihZnXY5gnO0=VO9UQymmgitZ-_EDEA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2020-09-24 20:07                     ` Roy Spliet
2020-09-24 15:38                 ` Jeremy Cline
2020-09-24 16:02             ` Jeremy Cline
     [not found]               ` <20200924160255.GB12520-5fq5eVrSFGCOnobEEGheSg@public.gmane.org>
2020-09-24 17:26                 ` Karol Herbst
     [not found]                   ` <CACO55tvdOWtqSLCZg+rYL--XY8sHipMTo2vDCCoJ9YD7eYhxHg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2020-09-24 17:47                     ` Karol Herbst
2020-09-24 18:18                     ` Jeremy Cline
     [not found]                       ` <20200924181810.GB17438-5fq5eVrSFGCOnobEEGheSg@public.gmane.org>
2020-09-24 19:17                         ` Karol Herbst
2020-10-06 21:13   ` Jeremy Cline [this message]
     [not found]     ` <20201006211313.49177-1-jcline-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2020-10-06 21:13       ` [RFC PATCH v2 1/3] drm/nouveau/kms/nvd9-: Introduce some kernel-docs for CRC support Jeremy Cline
2020-10-06 21:13       ` [RFC PATCH v2 2/3] nouveau: Add kernel-docs for module parameters Jeremy Cline
2020-10-06 21:13       ` [RFC PATCH v2 3/3] Documentation: nouveau: Introduce some nouveau documentation Jeremy Cline

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201006211313.49177-1-jcline@redhat.com \
    --to=jcline-h+wxahxf7alqt0dzr+alfa@public.gmane.org \
    --cc=bskeggs-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org \
    --cc=nouveau-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.