[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: d03e2375564ef7eb7a95b26e4f8318b7ca88526f Author: Ulrich Müller gentoo org> AuthorDate: Wed Mar 30 16:07:17 2022 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Mar 30 16:07:17 2022 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=d03e2375 ebuild-writing/user-submitted: Add cross-reference to copyright policy Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/user-submitted/text.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index a389677..364fa87 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -36,6 +36,8 @@ git commit's --author parameter to explicitly give them credit. Developers must check for a valid Signed-off-by line either within the provided patches by a user or within a comment on e.g. Bugzilla. +See +for details.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: 9034dc0f5a277f84a7ce8a4bf528979afe5bb4b5 Author: Sam James gentoo org> AuthorDate: Tue Mar 30 09:47:13 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 7 17:28:18 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9034dc0f ebuild-writing/user-submitted: mention checking for Signed-off-by Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/user-submitted/text.xml | 5 + 1 file changed, 5 insertions(+) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index c603e0a..a389677 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -33,6 +33,11 @@ may not be necessary. If that is not the case, you may wish to use git commit's --author parameter to explicitly give them credit. + +Developers must check for a valid Signed-off-by line either within +the provided patches by a user or within a comment on e.g. Bugzilla. + + Users should be encouraged to submit diffs to an existing ebuild if they are submitting an upgrade. Doing this will help to avoid re-introduction
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: 88cebf0c533c060e803a95927f1ffa8b2d5d9f8f Author: Sam James gentoo org> AuthorDate: Sun Mar 21 02:28:38 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 7 17:28:14 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=88cebf0c ebuild-writing/user-submitted: unified diffs are preferred Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/user-submitted/text.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index b5bc8a8..c603e0a 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -37,7 +37,7 @@ git commit's --author parameter to explicitly give them credit. Users should be encouraged to submit diffs to an existing ebuild if they are submitting an upgrade. Doing this will help to avoid re-introduction of previously fixed bugs into "new" ebuilds. When not working from a -diff but from a complete user-submitted ebuild, the diff command +diff but from a complete user-submitted ebuild, the diff -u command should be used to see what has changed; attention should be payed for anything from the current ebuild that should appear in the new ebuild, or anything in the new ebuild that should be fixed or removed.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: 71f8cc1a2a08d191c561b9af429df99189067879 Author: Sam James gentoo org> AuthorDate: Sun Mar 21 02:27:55 2021 + Commit: Ulrich Müller gentoo org> CommitDate: Wed Apr 7 17:28:13 2021 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=71f8cc1a ebuild-writing/user-submitted: mention git commit --author Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> ebuild-writing/user-submitted/text.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index b97af10..b5bc8a8 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -29,7 +29,8 @@ commit message format section, is highly encouraged. Note that ebuilds received in the form of git patches or pull requests will have the user as the commit author by default, in which case including the user information in the commit message explicitly -may not be necessary. +may not be necessary. If that is not the case, you may wish to use +git commit's --author parameter to explicitly give them credit.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: b2b11705f3fe10df6c632ec3e1dcd945b19dd36f Author: Gokturk Yuksek binghamton edu> AuthorDate: Thu Feb 4 00:57:34 2016 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Feb 5 12:58:19 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b2b11705 ebuild-writing/user-submitted: do not put user information in ChangeLog #558642 ChangeLog files are auto-generated by infra post git-migration. For user-submitted ebuilds, include the user information in the commit message instead. Mention that user submitted git patches and pull requests preserve the authorship information by default. Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642 Signed-off-by: Gokturk Yuksek binghamton.edu> ebuild-writing/user-submitted/text.xml | 10 ++ 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index ef80c0d..a148042 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -16,14 +16,16 @@ the ebuild meets all Gentoo Linux development standards. The user-submitted ebuild must not contain custom headers like this: - + # Ebuild updated by: me m...@example.com -Such information should be added to the ChangeLog instead. -The first ChangeLog entry should always credit the user who -submitted the ebuild, with their full name and e-mail address. +Such information should be included in the git commit message instead. +Note that ebuilds received in the form of git patches or pull requests +will have the user as the commit author by default, in which case +including the user information in the commit message explicitly +may not be necessary.
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/
commit: 277ded9ddd1000759727ffd2d0dbc61498b5d96e Author: Gokturk Yuksek binghamton edu> AuthorDate: Thu Feb 4 00:57:49 2016 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Feb 5 12:58:22 2016 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=277ded9d ebuild-writing/user-submitted: mention git style tags in commit messages #558642 Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642 Signed-off-by: Gokturk Yuksek binghamton.edu> ebuild-writing/user-submitted/text.xml | 4 1 file changed, 4 insertions(+) diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml index a148042..68c88f0 100644 --- a/ebuild-writing/user-submitted/text.xml +++ b/ebuild-writing/user-submitted/text.xml @@ -22,6 +22,10 @@ The user-submitted ebuild must not contain custom headers like this: Such information should be included in the git commit message instead. +The use of tags such as Suggested-By: or Reported-By:in +the commit message, as explained in the +commit +message format section, is highly encouraged. Note that ebuilds received in the form of git patches or pull requests will have the user as the commit author by default, in which case including the user information in the commit message explicitly
[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/user-submitted/, ebuild-writing/
commit: 75f4240dbc7b4710247e7b3ed3bb6e564cfbad60 Author: Ulrich Müller ulm AT gentoo DOT org AuthorDate: Sun May 3 17:17:29 2015 + Commit: Ulrich Müller ulm AT gentoo DOT org CommitDate: Wed May 6 22:06:49 2015 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=75f4240d Merge section about user-submitted ebuilds from Developer Handbook. This is taken from proj/en/devrel/handbook/hb-policy-ebuild.xml, section Ebuild policy, subsection User-submitted ebuilds. Permission to reuse the CC-BY-SA-1.0 work under CC-BY-SA-2.0 (or any later version) obtained from author plasmaroo per e-mail on 2015-04-16. ebuild-writing/text.xml| 1 + ebuild-writing/user-submitted/text.xml | 53 ++ 2 files changed, 54 insertions(+) diff --git a/ebuild-writing/text.xml b/ebuild-writing/text.xml index 2f55b47..9420045 100644 --- a/ebuild-writing/text.xml +++ b/ebuild-writing/text.xml @@ -29,5 +29,6 @@ with some general notes and extended examples. include href=using-eclasses// include href=functions// include href=misc-files// +include href=user-submitted// include href=common-mistakes// /guide diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml new file mode 100644 index 000..ef80c0d --- /dev/null +++ b/ebuild-writing/user-submitted/text.xml @@ -0,0 +1,53 @@ +?xml version=1.0? +guide self=ebuild-writing/user-submitted/ +chapter +titleUser-submitted Ebuilds/title + +body + +p +User-submitted ebuilds should never be blindly trusted and should +always be well-tested and audited before being committed to the tree. +The developer committing the user-submitted ebuild is vouching that +the ebuild meets all Gentoo Linux development standards. +/p + +p +The user-submitted ebuild must not contain custom headers like this: +/p + +pre caption=A custom header that should be transferred to the ChangeLog +# Ebuild updated by: me lt;m...@example.comgt; +/pre + +p +Such information should be added to the cChangeLog/c instead. +The first cChangeLog/c entry should always credit the user who +submitted the ebuild, with their full name and e-mail address. +/p + +p +Users should be encouraged to submit diffs to an existing ebuild if they +are submitting an upgrade. Doing this will help to avoid re-introduction +of previously fixed bugs into new ebuilds. When not working from a +diff but from a complete user-submitted ebuild, the cdiff/c command +should be used to see what has changed; attention should be payed for +anything from the current ebuild that should appear in the new ebuild, +or anything in the new ebuild that should be fixed or removed. +/p + +p +In general, it is preferable to have the user do the work required to +get their ebuild up to par, so that they can learn from their mistakes +and submit cleaner ebuilds in the future. Be sure to be thankful for any +submission, even if it isn't very good. Be polite but honest d/ if an +ebuild isn't usable, the user can be told in a way that does not insult +their current ebuild-writing abilities. Remember that the user who +submitted that broken ebuild may be a skilled and productive member of +our project in the future d/ that is, if they receive the right amount +of encouragement and support and continue to improve in their abilities. +/p + +/body +/chapter +/guide
