diff options
| author | Benjamin Li <benl@squareup.com> | 2021-05-09 09:01:38 -0700 |
|---|---|---|
| committer | Benjamin Li <benl@squareup.com> | 2021-05-09 09:01:40 -0700 |
| commit | 92c6a40d5240b2b58bbe9c52eb7e7a4692380ad9 (patch) | |
| tree | a77948983b3bac18d0ca002dce9ac40c578e2081 | |
| parent | f75099aa93bf8074cfe97aa2377534ccfe6a330d (diff) | |
| download | drm_hwcomposer-92c6a40d5240b2b58bbe9c52eb7e7a4692380ad9.tar.gz | |
drm_hwcomposer: update README for clang-format-diff-11 and touch up formatting
The README.md is out of date -- clang-format-diff-5.0 is not what runs on
CI anymore. To help contributors better test their changes locally before
submitting a merge request, update to the actual linting command being run
in CI.
Signed-off-by: Benjamin Li <benl@squareup.com>
| -rw-r--r-- | README.md | 34 |
1 files changed, 22 insertions, 12 deletions
@@ -1,19 +1,29 @@ -drm_hwcomposer +drm\_hwcomposer ====== -Patches to drm_hwcomposer are very much welcome, we really want this to be the -universal HW composer implementation for Android and similar platforms -So please bring on porting patches, bugfixes, improvements for documentation -and new features. +Patches to drm\_hwcomposer are very much welcome, we really want this to be the +universal HW composer implementation for Android and similar platforms. So +please bring on porting patches, bugfixes, improvements for documentation and +new features. A short list of contribution guidelines: -* Submit changes via gitlab merge requests on gitlab.freedesktop.org -* drm_hwcomposer is Apache 2.0 Licensed and we require contributions to follow the developer's certificate of origin: http://developercertificate.org/ -* When submitting new code please follow the naming conventions documented in the generated documentation. Also please make full use of all the helpers and convenience macros provided by drm_hwcomposer. The below command can help you with formatting of your patches: - - `git diff | clang-format-diff-5.0 -p 1 -style=file` -* Hardware specific changes should be tested on relevant platforms before committing. +* Submit changes via gitlab merge requests on gitlab.freedesktop.org. +* drm\_hwcomposer is Apache 2.0 Licensed and we require contributions to follow + the developer's certificate of origin: http://developercertificate.org/. +* When submitting new code please follow the naming conventions documented in + the generated documentation. Also please make full use of all the helpers and + convenience macros provided by drm\_hwcomposer. The below command can help + you with formatting of your patches: -If you need inspiration, please checkout our [TODO issues](https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer/issues?label_name%5B%5D=TODO) + ``` + git diff | clang-format-diff-11 -p 1 -style=file + ``` + +* Hardware specific changes should be tested on relevant platforms before + committing. + +If you need inspiration, please checkout our [TODO issues][1]. Happy hacking! + +[1]: https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer/issues?label_name%5B%5D=TODO |