Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 445402 - add "Ebuild Comitting Guide"
Summary: add "Ebuild Comitting Guide"
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords: PATCH, REVIEWED
Depends on:
Blocks:
 
Reported: 2012-11-30 23:06 UTC by Julian Ospald
Modified: 2013-03-17 22:57 UTC (History)
4 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
ebuild-committing-guide.patch (ebuild-committing-guide.patch,3.42 KB, patch)
2012-11-30 23:06 UTC, Julian Ospald
Details | Diff
ebuild-committing-guide.patch (ebuild-committing-guide.patch,3.61 KB, patch)
2012-12-04 18:14 UTC, Julian Ospald
Details | Diff
ebuild-committing-guide.patch (ebuild-committing-guide.patch,3.65 KB, patch)
2012-12-04 18:47 UTC, Julian Ospald
Details | Diff
touch-me-softly.patch (text.xml.patch,1.52 KB, patch)
2013-01-19 11:23 UTC, Julian Ospald
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Julian Ospald 2012-11-30 23:06:46 UTC
Created attachment 331090 [details, diff]
ebuild-committing-guide.patch

This should be a top-section including stuff from
http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=1
and probably also CVS related things
http://www.gentoo.org/doc/en/cvs-tutorial.xml#doc_chap2

From a recent discussion in #gentoo-dev a proposal emerged: Make a soft policy of 2 weeks or so before you fix bugs on your own. This should exclude toolchain/base-system/core stuff or eclass related things.
Comment 1 Markos Chandras (RETIRED) gentoo-dev 2012-11-30 23:37:01 UTC
what #gentoo-dev discussion? We can't just document stuff based on some random discussion on IRC. Especially this kind of policy needs a global consensus or at lease give the entire dev community a chance to discuss about this. And I am not sure if commit policy is meant to be on devmanual anyway. The devmanual is about technical stuff.
Comment 2 Markos Chandras (RETIRED) gentoo-dev 2012-11-30 23:37:25 UTC
s/lease/least
Comment 3 Julian Ospald 2012-12-02 15:11:15 UTC
uhm, this is not some random thing

Actually my recruiter told me this too (however the suggested timeframe was more like 1-2 months), but it's just not officially documented anywhere.

But well, I'll send an email to gentoo-dev.
Comment 4 Markos Chandras (RETIRED) gentoo-dev 2012-12-02 16:19:40 UTC
There is no documented policy. The unofficial policy is not a *policy* so before we write something down, we first need to discuss it
Comment 5 Rick Farina (Zero_Chaos) gentoo-dev 2012-12-04 17:50:17 UTC
+<p>Usually you don't just change another developers ebuild without a word unless you know he does not mind or if you are part of the herd involved in maintenance. Start with filing a bug or try to catch him on IRC or via email. Sometimes you cannot reach him or there is no response to your bug. Then a soft limit of 2 to 4 weeks depending on the severity of the bug is an acceptable timeframe before you go ahead and fix it yourself.</p> 


I realize that this is left intentionally vague, but this policy essentially says "Don't touch anything without 2-4 weeks notice and no response, unless you know something somehow".  I says specifically "unless you know he does not mind" but it doesn't really provide a way to say "I don't mind". I would like the policy to officially state how people can say "I don't mind".

Suggestion would be adding the following after "herd involved in maintenance.  "

"Information about policies specific to a maintainer or package can often be found in the metadata.xml, such as <description>Please feel free to fix my bugs</description>"

I don't necessarily require this exact verbiage, however, I feel this is important enough to be specifically stated in the policy.
Comment 6 Rick Farina (Zero_Chaos) gentoo-dev 2012-12-04 18:06:21 UTC
Additional suggestion:

after "go ahead and fix it yourself.  "

Something to the effect of "For a sufficiently important issue (something that would harm the users waiting 2-4 weeks on) it would be advisable to bring the issue to the attention of one of the mailing lists or irc channels for advice on how to handle the issue.  Many times people can step in to fix critical breakage when the maintainer isn't around if it really is necessary to maintain a good user experience."
Comment 7 Julian Ospald 2012-12-04 18:14:29 UTC
Created attachment 331420 [details, diff]
ebuild-committing-guide.patch

incorporated the suggestions from Zero_Chaos, thanks
Comment 8 Julian Ospald 2012-12-04 18:47:11 UTC
Created attachment 331426 [details, diff]
ebuild-committing-guide.patch

some spell checking and stuff by Zero_Chaos
Comment 9 Rick Farina (Zero_Chaos) gentoo-dev 2012-12-04 18:56:41 UTC
I didn't see a single other voice of dissent on the ML so I'll add my ACK here so it is known that I approve of this in its current form.
Comment 10 Markos Chandras (RETIRED) gentoo-dev 2012-12-04 19:07:21 UTC
give us sometime to review the patch :)
Comment 11 Markos Chandras (RETIRED) gentoo-dev 2013-01-19 10:17:44 UTC
I don't like this patch. First of all, it is incomplete and the section about "Changing others ebuilds" could easily go here

http://devmanual.gentoo.org/ebuild-writing/ebuild-maintenance/index.html
Comment 12 Julian Ospald 2013-01-19 11:04:52 UTC
ofc it's incomplete

however, would be fine for me as well if the "Changing/Fixing other developers ebuilds" section goes into "Ebuild Maintenance"
Comment 13 Julian Ospald 2013-01-19 11:23:58 UTC
Created attachment 336126 [details, diff]
touch-me-softly.patch
Comment 14 Markos Chandras (RETIRED) gentoo-dev 2013-02-15 23:50:01 UTC
The patch looks good to me. Please commit
Comment 15 Julian Ospald 2013-03-17 22:57:10 UTC
committed