[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/, ebuild-maintenance/, ...
commit: fc3dbac6583d211d9ad804d82f47c1bb50722ced
Author: Ulrich Müller gentoo org>
AuthorDate: Tue Jan 21 10:58:34 2020 +
Commit: Ulrich Müller gentoo org>
CommitDate: Thu Jan 23 07:48:06 2020 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fc3dbac6
ebuild-maintenance/collisions: New chapter.
Split off from ebuild-maintenance/maintenance-tasks.
Signed-off-by: Ulrich Müller gentoo.org>
.../{maintenance-tasks => collisions}/text.xml | 30 +-
ebuild-maintenance/maintenance-tasks/text.xml | 47 --
ebuild-maintenance/text.xml| 1 +
3 files changed, 3 insertions(+), 75 deletions(-)
diff --git a/ebuild-maintenance/maintenance-tasks/text.xml
b/ebuild-maintenance/collisions/text.xml
similarity index 72%
copy from ebuild-maintenance/maintenance-tasks/text.xml
copy to ebuild-maintenance/collisions/text.xml
index 8a2c3fc..6f5cec6 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/collisions/text.xml
@@ -1,18 +1,7 @@
-
+
-Maintenance Tasks
-
-
-
-This guide aims to explain common everyday ebuild maintenance
-routines, as well as other rarer maintenance routines which
-developers may not be familiar with.
-
-
-
-
-Conflicting files
+Package Collisions
@@ -56,20 +45,5 @@ won't overwrite them).
-
-
-
-Homepage unavailable
-
-
-
-If the HOMEPAGE of your package seems to be unavailable or it
-never existed at all, please set the HOMEPAGE variable in every ebuild
-to https://wiki.gentoo.org/wiki/No_homepage;>
-https://wiki.gentoo.org/wiki/No_homepage
-
-
-
-
diff --git a/ebuild-maintenance/maintenance-tasks/text.xml
b/ebuild-maintenance/maintenance-tasks/text.xml
index 8a2c3fc..ccdefe9 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/maintenance-tasks/text.xml
@@ -11,53 +11,6 @@ developers may not be familiar with.
-
-Conflicting files
-
-
-
-When you encounter a package that is trying to install files that are
-already provided by another package (detectable with
-FEATURES=collision-protect for example) you have to fix this
-situation before you can commit the ebuild or, if you encounter this
-with an existing package, file a bug about that package (see below for
-a few exceptions). The reason file conflicts are critical is because
-if "foo" provides the file /usr/bin/example and "bar" is
-going to overwrite it, and later "bar" is unmerged, Portage will remove
-/usr/bin/example and it is therefore likely it will break
-"foo".
-
-
-
-The most obvious fix is to add a blocking dependency to both packages
-that want to install that file, so they can't be installed at the same
-time. But unless there are also other reasons for those packages to
-block each other you should avoid this if possible and rather fix the
-package, which could include one or more of the following steps:
-
-
-
- Make "foo" (R)DEPEND on "bar" and not install the conflicting
- file.
- Remove conflicting files from "foo" in src_install
- or pkg_preinst.
- Move conflicting files into a new subpackage and make "foo" and
- "bar" both (R)DEPEND on that package.
- Change the location where "foo" or "bar" installs conflicting
- files.
-
-
-
-In some cases conflicting files can't be really fixed or aren't
-critical, currently known exceptions are Perl module manpages
-(overwriting the ones from Perl itself) and CONFIG_PROTECT'ed
-files (which should still be fixed, but aren't critical as Portage
-won't overwrite them).
-
-
-
-
-
Homepage unavailable
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
index b298807..1917b07 100644
--- a/ebuild-maintenance/text.xml
+++ b/ebuild-maintenance/text.xml
@@ -20,6 +20,7 @@ This section covers various tasks related to working with
ebuilds.
+
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/
commit: 9a0fa8fddd12e209a39649505a2d1accfbfdb4b4 Author: Miroslav Šulc fordfrog com> AuthorDate: Wed Dec 18 22:04:21 2019 + Commit: Göktürk Yüksek gentoo org> CommitDate: Wed Dec 18 23:57:19 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9a0fa8fd ebuild-maintenance/maintenance-tasks: add missing '--signoff' in pkgmove when moving a package, the git commit command must also contain --signoff as without it Signed-off-by is not added to the commit message and git server rejects the commit. also updated commit message to one that contains Signed-off-by. (The commit message subject line is modified by the committer) Closes: https://github.com/gentoo/devmanual/pull/124 Signed-off-by: Miroslav Šulc gentoo.org> Signed-off-by: Göktürk Yüksek gentoo.org> ebuild-maintenance/maintenance-tasks/text.xml | 12 +++- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml index 78abcca..1fa67dc 100644 --- a/ebuild-maintenance/maintenance-tasks/text.xml +++ b/ebuild-maintenance/maintenance-tasks/text.xml @@ -313,7 +313,7 @@ Here is an example where the package profiles/package.mask -Commit all the changes in one commit using: git commit --gpg-sign +Commit all the changes in one commit using: git commit --gpg-sign --signoff Update any news items @@ -330,11 +330,13 @@ to the following: -commit d391643289097344a0b18ab2665bb26198a0e3a1 -Author: Guilherme Amadio ama...@gentoo.org -Date: Tue Nov 3 20:26:52 2015 +0100 +commit 7a699bcdce5c1412c02a2aa7717a31bc17c49058 +Author: Miroslav Šulc fordf...@gentoo.org +Date: Wed Dec 18 19:56:03 2019 +0100 - media-fonts/nanumfont: renamed to media-fonts/nanum + media-libs/libclxclient: moved to x11-libs/libclxclient + + Signed-off-by: Miroslav Šulc fordf...@gentoo.org
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/, ebuild-writing/common-mistakes/, ...
commit: e2a34ce393ae620d239330d73cba9153ed7fdd13
Author: Ulrich Müller gentoo org>
AuthorDate: Wed Dec 4 17:18:45 2019 +
Commit: Ulrich Müller gentoo org>
CommitDate: Sun Dec 8 11:32:04 2019 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e2a34ce3
Drop caption attribute from elements.
This isn't processed by devbook.xsl and doesn't show up in the output.
Signed-off-by: Ulrich Müller gentoo.org>
ebuild-maintenance/git/text.xml | 6 +++---
ebuild-maintenance/maintenance-tasks/text.xml | 8
ebuild-writing/common-mistakes/text.xml | 8
ebuild-writing/user-submitted/text.xml| 2 +-
4 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index ee32c9c..ba811ac 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -63,7 +63,7 @@ To ensure that the Gentoo policies are followed, you should
set the following
configuration variables:
-
+
git config --local user.name "${YOUR_FULL_NAME}"
# use your @gentoo.org address even if you have a different default
git config --local user.email "${YOUR_NICKNAME}@gentoo.org"
@@ -89,7 +89,7 @@ To include the converted CVS history in the git repository,
you can
graft it into the repository:
-
+
git remote add history
https://anongit.gentoo.org/git/repo/gentoo/historical.git/
git fetch history
git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d history/master
@@ -305,7 +305,7 @@ message.
An example commit message is shown below:
-
+
app-misc/foo: version bump to 0.5
This also adds a new USE flag 'bar' which controls the
diff --git a/ebuild-maintenance/maintenance-tasks/text.xml
b/ebuild-maintenance/maintenance-tasks/text.xml
index 92dd0a0..50fe2f2 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/maintenance-tasks/text.xml
@@ -257,7 +257,7 @@ the latest file in profiles/updates/ in the
following format:
-
+
move old-category/package-name new-category/package-name
@@ -350,7 +350,7 @@ also need to create a new entry in
profiles/updates/ in
the Gentoo repository in the following format:
-
+
slotmove app-text/gtkspell 0 2
@@ -423,7 +423,7 @@ Here is a list of commands that will delete
dev-util/pmk
from the tree:
-
+
# cd dev-qt
# git rm -rf qtphonon
# git commit --gpg-sign
@@ -433,7 +433,7 @@ from the tree:
An example commit message is shown below:
-
+
commit b97eb6d43f45dfd5b739638928db22d3f3392685
Author: Michael Palimaka kensing...@gentoo.org
Date: Tue Oct 3 21:43:03 2017 +1100
diff --git a/ebuild-writing/common-mistakes/text.xml
b/ebuild-writing/common-mistakes/text.xml
index dbf6eee..cee330d 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -179,7 +179,7 @@ skel.ebuild.
The first two lines must look like this:
-
+
# Copyright 1999-2019 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
@@ -222,7 +222,7 @@ number is not consistent with the tarball/source, then use
MY_P. An example
dev-python/pyopenal fetches a tarball called PyOpenAL, so we redefine it like:
-
+
MY_P=${P/pyopenal/PyOpenAL}
SRC_URI="http://download.gna.org/pyopenal/${MY_P}.tar.gz;
S=${WORKDIR}/${MY_P}
@@ -352,7 +352,7 @@ Make sure you have the SLOT variable in the ebuild. If you
don't plan to use it,
don't remove it. Put in:
-
+
SLOT="0"
@@ -503,7 +503,7 @@ It is wise to submit a diff for a package update rather
than the whole ebuild.
The best way to generate it would be:
-
+
$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild
~/some-package-0.2.0.diff
diff --git a/ebuild-writing/user-submitted/text.xml
b/ebuild-writing/user-submitted/text.xml
index 68c88f0..2f384ca 100644
--- a/ebuild-writing/user-submitted/text.xml
+++ b/ebuild-writing/user-submitted/text.xml
@@ -16,7 +16,7 @@ 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
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/
commit: ddeb8e005a8216011b00b7cd4dcc47bb33150015 Author: Michał Górny gentoo org> AuthorDate: Mon Sep 9 07:17:46 2019 + Commit: Göktürk Yüksek gentoo org> CommitDate: Wed Oct 16 18:49:09 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ddeb8e00 ebuild-maintenance/maintenance-tasks: "Touching other..." moved The "Touching other developers ebuilds" section has been effectively moved to "Package Maintainers". Remove the duplicate. Closes: https://github.com/gentoo/devmanual.gentoo.org/pull/104 Acked-by: Michael Orlitzky gentoo.org> Signed-off-by: Michał Górny gentoo.org> Signed-off-by: Göktürk Yüksek gentoo.org> ebuild-maintenance/maintenance-tasks/text.xml | 33 --- 1 file changed, 33 deletions(-) diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml index 06634b8..7e73937 100644 --- a/ebuild-maintenance/maintenance-tasks/text.xml +++ b/ebuild-maintenance/maintenance-tasks/text.xml @@ -136,39 +136,6 @@ which is often more convenient. - -Touching other developers ebuilds - - -Usually you don't just change other developers ebuilds without -permission unless you know that developer does not mind or if you are -part of the project involved in maintenance (this information can -typically be found in metadata.xml). Start with filing a bug or trying -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 issue that needs to be handled ASAP. Otherwise a soft limit -of 2 to 4 weeks depending on the severity of the bug is an acceptable -time frame before you go ahead and fix it yourself. - - -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. - - - -Respect developers' coding preferences. Unnecessarily changing the -syntax of an ebuild can cause complications for others. Syntax changes -should only be done if there is a real benefit, such as faster -compilation, improved information for the end user, or compliance with -Gentoo policies. - - - - - Stabilizing ebuilds
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/
commit: e86291bf6f6c1a93a6144d6995396a80cb402fa6 Author: Ulrich Müller gentoo org> AuthorDate: Wed Aug 22 05:02:52 2018 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Sep 23 06:55:56 2018 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e86291bf ebuild-maintenance/maintenance-tasks: Amend section on package removal. Clarify that reverse dependencies are to be removed. ebuild-maintenance/maintenance-tasks/text.xml | 9 +++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml index 10e25d9..e4a173f 100644 --- a/ebuild-maintenance/maintenance-tasks/text.xml +++ b/ebuild-maintenance/maintenance-tasks/text.xml @@ -437,13 +437,18 @@ When removing packages follow these steps: -Make sure that no dependencies in Portage are broken due to the removal +Make sure that no dependencies in the Gentoo repository are broken due to +the removal Send last rites to gentoo-dev-announce and gentoo-dev Mask the package Wait 30 days (or more) Remove from the git tree unless the reason for removal has been fixed - Remove package.mask entry + +Remove any references to the package from other ebuilds, e.g., +use-conditional dependencies. Blockers are the only exception to this. + + Remove package.mask and any package.use.mask entries Remove the pkg tags referencing this package in the metadata.xml
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/
commit: 74b1623b6414166c1091c08ee90f2d5a509c3da8 Author: Göktürk Yüksek gentoo org> AuthorDate: Wed Dec 13 18:06:09 2017 + Commit: Göktürk Yüksek gentoo org> CommitDate: Wed Jan 3 05:05:41 2018 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=74b1623b ebuild-maintenance: remove the Gentoo-Bug tag in the package removal subsection Per GLEP 66, the tags Bug and Closes should be used when referring to bugs. The example only illustrates the use of Closes per the commit message. Acked-by: Michael Orlitzky gentoo.org> Closes: https://bugs.gentoo.org/640788 ebuild-maintenance/maintenance-tasks/text.xml | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml index 003d14e..5e67a46 100644 --- a/ebuild-maintenance/maintenance-tasks/text.xml +++ b/ebuild-maintenance/maintenance-tasks/text.xml @@ -458,8 +458,8 @@ from the tree: -# cd dev-util -# git rm -rf pmk +# cd dev-qt +# git rm -rf qtphonon # git commit --gpg-sign @@ -468,13 +468,13 @@ An example commit message is shown below: -commit e0bbcf8291501dc7de6b4b120d4372061367dd7a +commit b97eb6d43f45dfd5b739638928db22d3f3392685 Author: Michael Palimaka kensing...@gentoo.org -Date: Fri Jan 29 07:11:01 2016 +1100 +Date: Tue Oct 3 21:43:03 2017 +1100 - dev-util/pmk: remove last-rited package + dev-qt/qtphonon: remove last rited package - Gentoo-bug: 541522 + Closes: https://bugs.gentoo.org/629144
[gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/, ebuild-maintenance/git/
commit: e567fc6f7d05d509bdac865606271f0bc2e132d6
Author: Michał Górny gentoo org>
AuthorDate: Sat Oct 14 18:14:40 2017 +
Commit: Göktürk Yüksek gentoo org>
CommitDate: Wed Jan 3 04:31:48 2018 +
URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=e567fc6f
Move the commit policy & commit message to git
ebuild-maintenance/git/text.xml | 158 ++
ebuild-maintenance/maintenance-tasks/text.xml | 151
2 files changed, 158 insertions(+), 151 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 2070217..59f1833 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -107,6 +107,164 @@ the historical commits after the initial git commit.
+
+Committing to gentoo.git
+
+
+
+Git Commit Policy
+
+
+
+Always run repoman scan before you commit.
+Please run repoman full before you commit.
+Always test that package.mask is okay by doing
+emerge --pretend mypkg before you commit and check
+that it doesn't contain any conflicts.
+Always commit the updated package.mask before
+the updated package.
+Always do atomic commits; if you commit a package with a new license,
+or that is masked, then first commit the revised package.mask
and/or license,
+then commit the ebuild, patches
+and metadata.xml all in
one go
+.
+ Although the set of changes in a single git commit is atomic, and
+combining package.mask/license changes with ebuild changes in a
+single commit wouldn't break atomicity, it is not currently possible to do so
+using repoman commit.
+
+
+
+
+
+
+
+Git Commit Message Format
+
+
+
+It is important to format the commit messages properly so that they
+communicate the changes to the reader in a clear and concise
+way. Additionally, consistency in message format allows for easier
+parsing by external tools. The first line of the commit message should
+contain a brief summary of the changes, followed by an empty new
+line. From the third line onward should be a detailed, multiline
+explanation of the changes introduced by the commit. At the very end,
+auxiliary information such as the bugs related to the commit,
+contributors, and reviewers should be listed using RFC822/git style
+tags. The length of the lines in the message should be 70-75
+characters at maximum.
+
+
+
+The summary line should start with referencing what is affected by the
+change followed by a colon ':' character. Use the rules in the
+following list to determine the proper format based on what has
+changed, substituting the package, category and eclass names
+appropriately:
+
+
+${CATEGORY}/${PN}:Single Package (Note that repoman commit
+automatically inserts this for you)
+${CATEGORY}: Package Category
+profiles: Profile Directory
+${ECLASS}.eclass: Eclass Directotry
+licenses: Licenses Directory
+metadata: Metadata Directory
+
+
+For packages where ${CATEGORY}/${PN}: is long, the line length
+limit can be exceeded, if absolutely necessary, to ensure a more
+useful summary line. If a commit affects multiple directories, prepend
+the message with which reflects the intention of the change best. If
+there are any bugs on Gentoo Bugzilla associated with the commit, id
+of the bug can be appended to the summary line using the format
+#BUG-ID. If you are modifying keywords, clearly state what
+keywords are added/removed.
+
+
+By default, lines starting with # are considered to be comments
+by git and not included in the commit message. Make sure that a new
+line does not start with #BUG-ID. Optionally, git can be
+configured to use a different character for comments by changing the
+commentchar option.
+
+
+
+
+For non-trivial commits, the message should contain a detailed
+explanation of what the commit intends to change, why it is required,
+and how it is accomplished, along with any other supplementary
+information.
+
+
+
+Finally the commit message should list auxiliary information such as
+people who are involved in authoring, suggesting, reviewing and
+testing the changes, and revelant bugs. Use RFC822/git style tags as
+explained in the
+https://kernel.org/doc/html/latest/process/submitting-patches.html;>
+Linux Kernel patch guideline. Additionally, the following tags
+are optionally used in Gentoo:
+
+
+Bug: Use this to reference bugs without closing them.
+The value is a URL to the bug. If multiple bugs need to be referenced,
+each one should be listed in a separate Bug tag. If a bug
+on Gentoo Bugzilla, or an issue or a pull request on GitHub
+is referenced, a reference to the commit will be added
+automatically.
+Closes: Use this to reference bugs and close them
+automatically. Alike Bug:, the value is a single URL to the bug,
+and multiple tags can be used to close multiple bugs. If a bug on Gentoo
+Bugzilla, or an issue or a pull request on a GitHub repository
+mirrored by Gentoo is referenced, it will be closed (as fixed)
+automatically with reference to the
