From: Francois Dugast <francois.dugast@intel.com>
To: intel-xe@lists.freedesktop.org
Cc: Francois Dugast <francois.dugast@intel.com>
Subject: [PATCH v1 00/14] uAPI Alignment - Documentation
Date: Thu, 7 Dec 2023 13:49:55 +0000 [thread overview]
Message-ID: <20231207135009.7-1-francois.dugast@intel.com> (raw)
This series is an attempt to improve the documentation in xe_drm.h in order
to make its use easier by user space. The structure of the file is made
explicit, the same rules are applied everywhere, the generated kernel doc
is more complete. The series addresses some comments made by Oded:
https://lists.freedesktop.org/archives/intel-xe/2023-May/004704.html
There is no functional change.
Francois Dugast (11):
drm/xe/uapi: Add a comment to each struct
drm/xe/uapi: Add missing documentation for struct members
drm/xe/uapi: Document use of size in drm_xe_device_query
drm/xe/uapi: Document drm_xe_query_config keys
drm/xe/uapi: Document DRM_XE_DEVICE_QUERY_HWCONFIG
drm/xe/uapi: Make constant comments visible in kernel doc
drm/xe/uapi: Replace BO with GEM in documentation
drm/xe/uapi: Add block diagram of a device
drm/xe/uapi: Add examples of user space code
drm/xe/uapi: Move CPU_CACHING defines before doc
drm/xe/uapi: Move DRM_XE_ACC_GRANULARITY_* where they are used
Rodrigo Vivi (3):
drm/xe/uapi: Order sections
drm/xe/uapi: More uAPI documentation additions and cosmetic updates
drm/xe/uapi: Document the memory_region bitmask
drivers/gpu/drm/xe/xe_query.c | 19 +
include/uapi/drm/xe_drm.h | 758 +++++++++++++++++++++++-----------
2 files changed, 544 insertions(+), 233 deletions(-)
--
2.34.1
next reply other threads:[~2023-12-07 13:50 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-07 13:49 Francois Dugast [this message]
2023-12-07 13:49 ` [PATCH v1 01/14] drm/xe/uapi: Add a comment to each struct Francois Dugast
2023-12-14 14:17 ` Rodrigo Vivi
2023-12-07 13:49 ` [PATCH v1 02/14] drm/xe/uapi: Add missing documentation for struct members Francois Dugast
2023-12-14 14:17 ` Rodrigo Vivi
2023-12-07 13:49 ` [PATCH v1 03/14] drm/xe/uapi: Document use of size in drm_xe_device_query Francois Dugast
2023-12-13 18:16 ` Rodrigo Vivi
2023-12-07 13:49 ` [PATCH v1 04/14] drm/xe/uapi: Document drm_xe_query_config keys Francois Dugast
2023-12-13 18:14 ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 05/14] drm/xe/uapi: Document DRM_XE_DEVICE_QUERY_HWCONFIG Francois Dugast
2023-12-13 18:14 ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 06/14] drm/xe/uapi: Make constant comments visible in kernel doc Francois Dugast
2023-12-13 18:16 ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 07/14] drm/xe/uapi: Replace BO with GEM in documentation Francois Dugast
2023-12-07 14:49 ` Matthew Auld
2023-12-13 18:27 ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 08/14] drm/xe/uapi: Order sections Francois Dugast
2023-12-14 20:57 ` Lucas De Marchi
2023-12-15 4:06 ` Aravind Iddamsetty
2023-12-07 13:50 ` [PATCH v1 09/14] drm/xe/uapi: More uAPI documentation additions and cosmetic updates Francois Dugast
2023-12-14 16:45 ` Lucas De Marchi
2023-12-14 19:40 ` Francois Dugast
2023-12-07 13:50 ` [PATCH v1 10/14] drm/xe/uapi: Document the memory_region bitmask Francois Dugast
2023-12-14 21:23 ` Lucas De Marchi
2023-12-07 13:50 ` [PATCH v1 11/14] drm/xe/uapi: Add block diagram of a device Francois Dugast
2023-12-07 14:01 ` Souza, Jose
2023-12-07 13:50 ` [PATCH v1 12/14] drm/xe/uapi: Add examples of user space code Francois Dugast
2023-12-13 18:26 ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 13/14] drm/xe/uapi: Move CPU_CACHING defines before doc Francois Dugast
2023-12-13 18:18 ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 14/14] drm/xe/uapi: Move DRM_XE_ACC_GRANULARITY_* where they are used Francois Dugast
2023-12-13 18:17 ` Rodrigo Vivi
2023-12-07 16:42 ` ✓ CI.Patch_applied: success for uAPI Alignment - Documentation Patchwork
2023-12-07 16:42 ` ✗ CI.checkpatch: warning " Patchwork
2023-12-07 16:44 ` ✓ CI.KUnit: success " Patchwork
2023-12-07 16:51 ` ✓ CI.Build: " Patchwork
2023-12-07 16:51 ` ✓ CI.Hooks: " Patchwork
2023-12-07 16:53 ` ✓ CI.checksparse: " Patchwork
2023-12-07 17:28 ` ✓ CI.BAT: " Patchwork
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=20231207135009.7-1-francois.dugast@intel.com \
--to=francois.dugast@intel.com \
--cc=intel-xe@lists.freedesktop.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox