drm_hwcomposer: Add CONTRIBUTING file
PATCH 1/1 drm_hwcomposer: Add CONTRIBUTING file
Some basic guidelines for contributions could come in handy.
These are copied from IGT and modified to be suitable.
--- CONTRIBUTING | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTING
CONTRIBUTING new file +31 -0
@@ -0,0 +1,31 @@ +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: + +- Please submit patches formatted with git send-email/git format-patch or + equivalent to + + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposer patches are easily + identified in the massive amount mails on dri-devel. To ensure this is always + done, run: + + git config format.subjectprefix "PATCH hwc" + +- 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-3.5 -p 1 -style=file + +- Harware specific changes should get tested on relevant platforms + before committing. + +Happy hacking!
Signature · 6 lines
2.11.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 5 lines · Robert Foss
Some basic guidelines for contributions could come in handy.
These are copied from IGT and modified to be suitable.
Signed-off-by Robert Foss <[email protected]>
Quoted 43 lines
--- CONTRIBUTING | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTINGCONTRIBUTING new file +31
-1@@ -0,0 +1,31 @@ +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: + +- Please submit patches formatted with git send-email/git format-patch or + equivalent to + + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposer patches are easily + identified in the massive amount mails on dri-devel. To ensure this is always + done, run: + + git config format.subjectprefix "PATCH hwc" + +- 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-3.5 -p 1 -style=file + +- Harware specific changes should get tested on relevant platforms + before committing. + +Happy hacking! --
Quoted 2 lines
2.11.0
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 34 lines · Robert Foss
Some basic guidelines for contributions could come in handy.
These are copied from IGT and modified to be suitable.
Signed-off-by Robert Foss <[email protected]>--- CONTRIBUTING | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTINGCONTRIBUTING new file +18
-0@@ -0,0 +1,31 @@ +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: + +- Please submit patches formatted with git send-email/git format-patch or + equivalent to + + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposer patches are easily + identified in the massive amount mails on dri-devel. To ensure this is always + done, run: + + git config format.subjectprefix "PATCH hwc" +
CONTRIBUTING line 28
Quoted 10 lines
CONTRIBUTING new file +10
-0+- 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-3.5 -p 1 -style=file + +- Harware specific changes should get tested on relevant platforms
*Hardware
With that,
Quoted 6 lines
CONTRIBUTING new file +3
-0+ before committing. + +Happy hacking!Signature · 1 line
2.11.0
Signature · 5 lines
Sean Paul, Software Engineer, Google / Chromium OS _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Pushed!
Quoted 61 lines · Sean Paul
Quoted 47 lines · Robert Foss
Some basic guidelines for contributions could come in handy.
These are copied from IGT and modified to be suitable.
Signed-off-by Robert Foss <[email protected]>---
CONTRIBUTING | 31 +++++++++++++++++++++++++++++++1 file changed, 31 insertions(+)create mode 100644 CONTRIBUTING
CONTRIBUTING new file +1
-0@@ -0,0 +1,31 @@ +Patches to drm_hwcomposer are very much welcome, we really wantthis to be the
+universal HW composer implementation for Android and similar platforms
+So please bring on porting patches, bugfixes, improvements for documentationCONTRIBUTING new file +5
-0+and new features. + +A short list of contribution guidelines: + +- Please submit patches formatted with git send-email/git format-patch or
+ equivalent toCONTRIBUTING new file +4
-0+ + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposerpatches are easily
+ identified in the massive amount mails on dri-devel. To ensure this is always
+ done, run:CONTRIBUTING new file +4
-0+ + git config format.subjectprefix "PATCH hwc" + +- drm_hwcomposer is Apache 2.0 Licensed and we requirecontributions to follow the
+ developer's certificate of origin: http://developercertificate.o
rg/
+
+- When submitting new code please follow the naming conventions documentedQuoted 8 lines
+ in the generated documentation. Also please make full use of all the helpers and
+ convenience macros provided bydrm_hwcomposer. The below command can help you
+ with formatting of your patches:
+ git diff | clang-format-diff-3.5 -p 1 -style=file
+
+- Harware specific changes should get tested on relevant platforms*Hardware
With that,
Quoted 10 lines
Reviewed-by Sean Paul <[email protected]>Quoted 6 lines
+ before committing.
CONTRIBUTING new file +2
-0+ +Happy hacking!--
2.11.0
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Hi Rob,
Glad to see this. There's a couple of suggestions that I hope you'll find worth while.
Quoted 24 lines · Robert Foss
Some basic guidelines for contributions could come in handy.
These are copied from IGT and modified to be suitable.
Signed-off-by Robert Foss <[email protected]>--- CONTRIBUTING | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTINGCONTRIBUTING new file +8
-0@@ -0,0 +1,31 @@ +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: + +- Please submit patches formatted with git send-email/git format-patch or
CONTRIBUTING line 18
Quoted 10 lines
CONTRIBUTING new file +10
-0+ equivalent to + + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposer patches are easily + identified in the massive amount mails on dri-devel. To ensure this is always + done, run: + + git config format.subjectprefix "PATCH hwc" +
One can add this into the autogen.sh or whatever bootstrap file the project uses.
For example see https://cgit.freedesktop.org/mesa/drm/tree/autogen.sh
CONTRIBUTING line 27
Quoted 6 lines
CONTRIBUTING new file +6
-0+- 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-3.5 -p 1 -style=file +
One could wire that in the pre-merge hook on the server side. It should be quite lightweight, although I'm not sure about the integration with FDO's Debian(?) setup ;-)
-Emil
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Hey Emil,
Quoted 43 lines · Emil Velikov
Hi Rob,
Glad to see this. There's a couple of suggestions that I hope you'll find worth while.
On 22 September 2017 at 01:37, Robert Foss <[email protected]
Quoted 37 lines
wrote:
Some basic guidelines for contributions could come in handy.These are copied from IGT and modified to be suitable.
Signed-off-by Robert Foss <[email protected]>---
CONTRIBUTING | 31 +++++++++++++++++++++++++++++++1 file changed, 31 insertions(+)create mode 100644 CONTRIBUTING
CONTRIBUTING new file +1
-0@@ -0,0 +1,31 @@ +Patches to drm_hwcomposer are very much welcome, we really wantthis to be the
+universal HW composer implementation for Android and similar platforms
+So please bring on porting patches, bugfixes, improvements for documentationCONTRIBUTING new file +5
-0+and new features. + +A short list of contribution guidelines: + +- Please submit patches formatted with git send-email/git format-patch or
+ equivalent toCONTRIBUTING new file +4
-0+ + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposerpatches are easily
+ identified in the massive amount mails on dri-devel. To ensure this is always
Quoted 8 lines
CONTRIBUTING line 18
Quoted 4 lines
+ done, run:
CONTRIBUTING new file +3
-0+ + git config format.subjectprefix "PATCH hwc" +One can add this into the
autogen.shor whatever bootstrap file the project uses.
For example see https://cgit.freedesktop.org/mesa/drm/tree/autogen.sh
Adding an autogen.sh sounds like a good idea to me.
Quoted 12 lines
Quoted 11 lines
+- 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 bydrm_hwcomposer. The below command can help you
+ with formatting of your patches:
+ git diff | clang-format-diff-3.5 -p 1 -style=file
+
Quoted 3 lines
One could wire that in the pre-merge hook on the server side. It should be quite lightweight, although I'm not sure about the integration with FDO's Debian(?) setup ;-)
Yeah, me neither. Maybe asking Daniel Stone about how this should be done is the next step.
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 55 lines · Robert Foss
Hey Emil,
Quoted 43 lines · Emil Velikov
Hi Rob,
Glad to see this. There's a couple of suggestions that I hope you'll find worth while.
On 22 September 2017 at 01:37, Robert Foss <[email protected]
Quoted 37 lines
wrote:
Some basic guidelines for contributions could come in handy.These are copied from IGT and modified to be suitable.
Signed-off-by Robert Foss <[email protected]>--- CONTRIBUTING | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTINGCONTRIBUTING new file +1
-0@@ -0,0 +1,31 @@ +Patches to drm_hwcomposer are very much welcome, we really wantthis to be the
+universal HW composer implementation for Android and similar platforms
+So please bring on porting patches, bugfixes, improvements for documentationCONTRIBUTING new file +5
-0+and new features. + +A short list of contribution guidelines: + +- Please submit patches formatted with git send-email/git format-patch or
CONTRIBUTING new file +5
-0+ equivalent to + + dri-devel <[email protected]> + + Please use --subject-prefix="PATCH hwc" so that drm_hwcomposerpatches are easily
+ identified in the massive amount mails on dri-devel. To ensure this is alwaysQuoted 8 lines
CONTRIBUTING line 18
Quoted 4 lines
CONTRIBUTING new file +4
-0+ done, run: + + git config format.subjectprefix "PATCH hwc" +One can add this into the
autogen.shor whatever bootstrap file the project uses.
For example see https://cgit.freedesktop.org/mesa/drm/tree/autogen.sh
Quoted 1 line
Adding an
autogen.shsounds like a good idea to me.
Except autogen.sh is a standard step as part of an autotools workflow and would not be obvious to run in an Android env.
Rob
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 10 lines · Robert Foss
Quoted 10 lines
Quoted 9 lines
+- 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 bydrm_hwcomposer. The below command can help you
+ with formatting of your patches:
+ git diff | clang-format-diff-3.5 -p 1 -style=file
+
Quoted 7 lines
Quoted 3 lines
One could wire that in the pre-merge hook on the server side. It should be quite lightweight, although I'm not sure about the integration with FDO's Debian(?) setup ;-)
Yeah, me neither. Maybe asking Daniel Stone about how this should be done is the next step.
The package clang-format-3.5 would need to be installed, but other than that the integration would be rather trivial; just add this to the update hook:
format_diff=$(git diff -U0 $oldrev..$newrev | clang-format-diff-3.5 -p1) if [ -n "$format_diff" ]; then
echo 'Code is not formatted properly; please apply this change and try again:' printf -- '----8<----\n%s\n---->8----\n' "$format_diff"
exit 1
fi
Note that if malformatted commits are to be rejected, it might be best to have a pre-commit hook on each client (will need manual setup on each clone) to re-format the code before being committed and therefore before being sent to ML, to avoid patchwork losing track of reformatted patches.
Alternatively, such patches could be accepted with just a warning being printed when pushing, but there's a good chance such warnings would just end up being ignored.
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel