the patch has been modified to reflect Zero_Chaos suggestions: - tell where to look for herd or maintainer notes (such as "touch at will"): metadata.xml - explicitly say to contact other devs if unsure how to handle a situation, especially if it's a critical one
commit e6ebf193852f92aa1dfec162f1bcdc34e933eda1 Author: hasufell <julian.osp...@googlemail.com> Date: Sat Dec 1 00:04:51 2012 +0100
add ebuild comitting guide section diff --git a/ebuild-committing-guide/cvs-tutorial/text.xml b/ebuild-committing-guide/cvs-tutorial/text.xml new file mode 100644 index 0000000..a2bd612 --- /dev/null +++ b/ebuild-committing-guide/cvs-tutorial/text.xml @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<guide self="ebuild-committing-guide/cvs-tutorial/"> +<chapter> +<title>CVS Tutorial</title> + +<body> +<p> +TODO: write something here. +</p> +</body> + +</chapter> + +</guide> diff --git a/ebuild-committing-guide/ebuild-policy/text.xml b/ebuild-committing-guide/ebuild-policy/text.xml new file mode 100644 index 0000000..44ce9aa --- /dev/null +++ b/ebuild-committing-guide/ebuild-policy/text.xml @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<guide self="ebuild-committing-guide/ebuild-policy/"> +<chapter> +<title>Ebuild policy</title> + +<body> +<p> +TODO: write something here. +</p> +</body> + +</chapter> + +</guide> diff --git a/ebuild-committing-guide/text.xml b/ebuild-committing-guide/text.xml new file mode 100644 index 0000000..db8e982 --- /dev/null +++ b/ebuild-committing-guide/text.xml @@ -0,0 +1,23 @@ +<?xml version="1.0"?> +<guide self="ebuild-committing-guide/"> +<chapter> +<title>Ebuild Committing Guide</title> + +<body> +<p> +This section describes how to commit an ebuild. It covers the basics of handling CVS commits and desribes some ebuild and tree policies. +</p> +</body> + +<section> +<title>Contents</title> +<body> +<contentsTree maxdepth="1"/> +</body> +</section> +</chapter> + +<include href="ebuild-policy/"/> +<include href="tree-policy/"/> +<include href="cvs-tutorial/"/> +</guide> diff --git a/ebuild-committing-guide/tree-policy/text.xml b/ebuild-committing-guide/tree-policy/text.xml new file mode 100644 index 0000000..1c56a00 --- /dev/null +++ b/ebuild-committing-guide/tree-policy/text.xml @@ -0,0 +1,23 @@ +<?xml version="1.0"?> +<guide self="ebuild-committing-guide/tree-policy/"> +<chapter> +<title>Tree and Etiquette policy</title> + +<body> +<p> +This section outlines the etiquette policy for Gentoo developers and describes common sense when dealing with problems in the tree. +</p> +<section> +<title>Changing/Fixing other developers ebuilds</title> +<body> +<p>Usually you don't just change other developers ebuilds without a word unless you know he does not mind or if you are part of the herd involved in maintenance (those information can be found in metadata.xml). Start with filing a bug or try to catch them on IRC or via email. Sometimes you cannot reach them or there is no response to your bug. It's a good idea to consult other developers on how to handle the situation, especially if it's a critical one and needs to be handled ASAP. Otherwise 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> +<important> Common sense dictates to us that toolchain/base-system/core packages and eclasses or anything else which is delicate (e.g. glibc) or widely used (e.g. gtk+) should usually be left to those maintainers. If in doubt, don't touch it.</important> +</body> +</section> + + +</body> + +</chapter> + +</guide> diff --git a/text.xml b/text.xml index 88016b0..137a99f 100644 --- a/text.xml +++ b/text.xml @@ -50,6 +50,7 @@ section lists specific contributions to this manual. <include href="quickstart/"/> <include href="general-concepts/"/> <include href="ebuild-writing/"/> +<include href="ebuild-committing-guide/"/> <include href="eclass-writing/"/> <include href="profiles/"/> <include href="keywording/"/>