xref: /aosp_15_r20/external/drm_hwcomposer/README.md (revision 0a9764fe0a15e71ebbeb85e87e10990c23aab47f)
1*0a9764feSAndroid Build Coastguard Workerdrm\_hwcomposer
2*0a9764feSAndroid Build Coastguard Worker======
3*0a9764feSAndroid Build Coastguard Worker
4*0a9764feSAndroid Build Coastguard WorkerPatches to drm\_hwcomposer are very much welcome, we really want this to be the
5*0a9764feSAndroid Build Coastguard Workeruniversal HW composer implementation for Android and similar platforms. So
6*0a9764feSAndroid Build Coastguard Workerplease bring on porting patches, bugfixes, improvements for documentation and
7*0a9764feSAndroid Build Coastguard Workernew features.
8*0a9764feSAndroid Build Coastguard Worker
9*0a9764feSAndroid Build Coastguard WorkerA short list of contribution guidelines:
10*0a9764feSAndroid Build Coastguard Worker* Submit changes via gitlab merge requests on gitlab.freedesktop.org.
11*0a9764feSAndroid Build Coastguard Worker* drm\_hwcomposer is Apache 2.0 Licensed and we require contributions to follow
12*0a9764feSAndroid Build Coastguard Worker  the developer's certificate of origin: http://developercertificate.org/.
13*0a9764feSAndroid Build Coastguard Worker* When submitting new code please follow the naming conventions documented in
14*0a9764feSAndroid Build Coastguard Worker  the generated documentation. Also please make full use of all the helpers and
15*0a9764feSAndroid Build Coastguard Worker  convenience macros provided by drm\_hwcomposer. The below command can help
16*0a9764feSAndroid Build Coastguard Worker  you with formatting of your patches:
17*0a9764feSAndroid Build Coastguard Worker
18*0a9764feSAndroid Build Coastguard Worker    ```
19*0a9764feSAndroid Build Coastguard Worker    git diff | clang-format-diff-19 -p 1 -style=file
20*0a9764feSAndroid Build Coastguard Worker    ```
21*0a9764feSAndroid Build Coastguard Worker
22*0a9764feSAndroid Build Coastguard Worker* Hardware specific changes should be tested on relevant platforms before
23*0a9764feSAndroid Build Coastguard Worker  committing.
24*0a9764feSAndroid Build Coastguard Worker
25*0a9764feSAndroid Build Coastguard WorkerIf you need inspiration, please checkout our [TODO issues][1].
26*0a9764feSAndroid Build Coastguard Worker
27*0a9764feSAndroid Build Coastguard WorkerHappy hacking!
28*0a9764feSAndroid Build Coastguard Worker
29*0a9764feSAndroid Build Coastguard Worker[1]: https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer/issues?label_name%5B%5D=TODO
30