include/drm-uapi/README: Update README for drm uapi header files

This update:

 * Clarifies the information about the acceptable source trees for
   updating the include/drm-uapi Mesa directory

 * Includes information about the current drm tree location

 * Expands the explanation of the process for generating the
   drm-uapi files

 * Expands the explanation of how what information to include
   in the Mesa commit that updates the drm-uapi files.

Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29973>
This commit is contained in:
Jordan Justen 2024-06-28 13:06:36 -07:00 committed by Marge Bot
parent 0acdb82814
commit 58bf403e8b

View File

@ -3,21 +3,39 @@ required by several drivers to communicate with the kernel.
Whenever one of those driver needs new definitions for new kernel
APIs, these files should be updated.
These files in master should only be updated once the changes have landed
in the drm-next tree.
These files in upstream Mesa should only be updated once the changes
have landed in the drm-next branch of the drm repository.
You can copy files installed after running this from the kernel
repository, at version the drivers require :
The drm repository is currently located at:
* https://gitlab.freedesktop.org/drm/kernel
* git url: https://gitlab.freedesktop.org/drm/kernel.git
Tagged Linux kernel releases can also be used.
When using the drm repository, it is recommended that the headers are
generated using a *merge commit* in the drm-next branch. After
checking out the commit in the drm (or tagged Linux release) tree, the
drm-uapi files can be generated by running this from the drm tree:
$ make headers_install INSTALL_HDR_PATH=/path/to/install
The last update was done at the following kernel commit :
This will generate files under /path/to/install/include/drm which can
be copied into the Mesa include/drm-uapi directory. It is not required
to copy/update all kernel header files.
commit ea97a66a221893fb9b4d96688e759d1db2d6e683
Author: Lucas De Marchi <lucas.demarchi@intel.com>
AuthorDate: Thu Dec 21 14:28:04 2023 -0800
Commit: Dave Airlie <airlied@redhat.com>
CommitDate: Fri Dec 22 11:17:15 2023 +1000
The commit message for the Mesa drm-uapi update should include the
full commit version of the drm kernel tree. An easy way to generate
this is with the following command in the drm tree:
drm/xe: Disable 32bits build
$ git log -1 --pretty=short --no-decorate
Which would produce output similar to this to include in the Mesa
commit:
commit a78313bb206e0c456a989f380c4cbd8af8af7c76
Merge: 365aa9f57399 79655e867ad6
Author: Dave Airlie <airlied@redhat.com>
Merge tag 'drm-intel-gt-next-2024-06-12' of https://gitlab.freedesktop.org/drm/i915/kernel into drm-next