This guide aims to explain common everyday ebuild maintenance routines, as well as other rarer maintenance routines which developers may not be familiar with.
Before writing a new ebuild, check bugs.gentoo.org to see if an ebuild has already been written for the package, but has not yet been added to the Gentoo repository. Go to bugs.gentoo.org, choose query and select Advanced Search; as product select Gentoo Linux, as component select ebuilds. In the search field put the name of the ebuild and as status select all possible fields, then submit the query. For you lazy people, click here.
In general, the Gentoo repository should only be used for storing .ebuild files, as well as any relatively small companion files, such as patches or sample configuration files. These types of files should be placed in the mycat/mypkg/files directory to keep the main mycat/mypkg directory uncluttered. Exceptions to this rule are for larger patch files (we recommend this for patches above 20KB) which should be distributed as tarballs via the Gentoo mirror system so that people do not waste excessive amounts of bandwidth and hard drive space. Also, you should not add binary (non-ASCII) files to the git tree. Also, speaking of merging changes, any patches you add to Portage should generally not be compressed. This will allow git to merge changes and correctly inform developers of conflicts.
Remember, the packages that you commit must be ready out of the box for end users when committed as stable. Make sure that you have a good set of default settings that will satisfy the majority of systems and users that will use your package. If your package is broken, and you are not sure how to get it to work, check some other distributions that have done their own versions of the package. You can check Debian or Fedora for some examples.
When committing to git, all developers should use
git commit to submit their ebuilds. Before committing,
repoman full to make sure you didn't forget something.
When adding a new ebuild, you should only include
architectures on which you have actually tested the ebuild, confirming
that it works as it should and that
USE flags are properly
honoured in the resulting package which would be installed. If
possible, you should give the actual library or application thorough
testing as well, since you would be responsible for any breakages for
your architecture(s). Minimal testing such as checking that the
application starts up without any errors should always be performed.
If you are adding a user-submitted ebuild, do not assume that the
submitter has done testing on various architectures: often,
are cloned across packages or generated from documentation in the
source packages, which does not signify that the package does indeed
work on those architectures.
As noted earlier, under each package subdirectory is a files/ directory. Any patches, configuration files, or other ancillary files your package might require should be added to this directory; any files bigger than 20KB-or-so should go to the mirrors to lower the amount of (unneeded) files our users have to download. You may want to consider naming patches you create yourself just to get your package to build with a version-specific name, such as mypkg-1.0-gentoo.diff, or more simply, 1.0-gentoo.diff. Also note that the gentoo extension informs people that this patch was created by us, the Gentoo Linux developers, rather than having been grabbed from a mailing list or somewhere else. Again, you should not compress these patches.
Consider prefixing or suffixing (such as mypkg-1.0) every file you put into the files/ directory, so that the files used for each individual version on an ebuild are distinguishable from one another, and so that the changes between different revisions are visible. This is generally a really good idea :). You may want to use a different suffix if you wish to convey more meaning with the patch name.
If you have many files that should go into the files/ directory, consider creating subdirectories such as files/1.0/ and putting the relevant files in the appropriate subdirectory. If you use this method, you do not need to add version information to the names of the files, which is often more convenient.
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.
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.
Only architecture maintainers for a given architecture should mark packages as stable on that architecture. The maintainer of the package should always be contacted just in case there are reasons not to do so. The exception to this is if you are part of an architecture team, in which case you may mark the package stable for that architecture. If you are not part of an architecture team, you should consult the guidelines below; if the architecture you are looking for is not listed then please consult the relevant lead.
You should never stabilize packages on architectures for which you cannot test and instead you should file a bug to the relevant architecture team, such as firstname.lastname@example.org asking them to stabilize the ebuild. Alternatively, you may be able to find Gentoo developers on IRC who could help you with your request.
It is best to not use email@example.com, adding architecture teams onto a bug's CC list individually instead. That way teams can remove themselves from the list when they are done, giving a clear indication of which teams still have to stabilize a package.
SPARC: You must have prior permission from the arch lead. Usually we expect you to be on the sparc alias for QA reasons, although other arrangements can be made if you will only be working with a small group of packages.
ALPHA: Maintainers may keyword their own packages but are reminded to inform the Alpha team if they can help out with testing and keywording packages so the team can keep an eye out for possible keywording mistakes.
Exotic architectures (like alpha, ia64, sparc, hppa, ppc*) are short on manpower, so it's best if you avoid opening stabilization bugs for them unless it is absolutely necessary (eg, a reverse dependency for your package). More about keywording policies can be found in the keywording section.
Some architectures (like m68k, mips, s390, sh) do not maintain a stable keyword. So there is no use in marking a package stable for one of these architectures.
New ebuilds should rarely go in with "
arch" keywords and even if they do
not, the package must be tested on any architectures listed in the
KEYWORDS variable of the new ebuild.
Exceptions to the no "
arch" rule are major bug fixes, or
security fixes. If the previous version of the ebuild
KEYWORDS which you cannot test for, you should
downgrade them: turn any "
arch" keyword to "
~arch". If you
think that your package may not work at all even on "
then it is best to leave the keyword out and request testing from the
relevant team: if you are to do this, you must file a bug to the team
If a new version introduces new dependencies which are not available
on some architectures, then you should file a bug or ask on IRC before
you upgrade the package. If you really need to get the ebuild added in
a hurry, for example, for a security fix, then you should drop
KEYWORDS which are causing problems and CC the relevant
architectures on the bug - you should file a new bug to the
architecture in question regarding this if no bug is already
If there are no new dependencies, do not remove keywords if your
commit fails with repoman - please try a full
git pull and if
you still have problems, then commit with
repoman -I and file a
bug to the broken architecture, noting it in your git commit message.
Moving a package in the tree requires several operations. Firstly,
the package directory needs to be moved to the correct category
git mv. After this, a new entry needs to be added to
the latest file in profiles/updates/ in the
move old-category/package-name new-category/package-name
Following the update entry, ebuilds that have a dependency to this package (in other words, the reverse dependencies of the package to be moved) need to be updated properly.
Next is checking the files under profiles/ such as
profiles/package.mask and update them to reflect the ebuild
move. Various eclasses automatically provide some of the dependencies upon
inherit, so the files under eclass/ should be checked and updated
properly. If the package metadata.xml has tags with
attribute, they should be updated to reflect the move. The
metadata.xml for various packages may contain references to the
package being moved using the
<pkg> tag which need to be
updated accordingly as well. Lastly, the titles of the open bugs
related to the package should be updated.
Here is an example where the package net-misc/fwbuilder is transparently moved to net-firewall/fwbuilder:
git mv net-misc/fwbuilder net-firewall/fwbuilder
Add the following entry to the latest file in profile/updates/:
move net-misc/fwbuilder net-firewall/fwbuilder
<pkg>tag or the
git add. For example:
git add profiles/package.mask
git commit --gpg-sign
Display-If-Installedheader or in the item's body (and increment their
It is very important to commit all the changes in a single commit to ensure that no breakage occurs. The commit message should follow a format similar to the following:
commit d391643289097344a0b18ab2665bb26198a0e3a1 Author: Guilherme Amadio <firstname.lastname@example.org> Date: Tue Nov 3 20:26:52 2015 +0100 media-fonts/nanumfont: renamed to media-fonts/nanum
The process for changing the ebuild's SLOT is very similar to the previous process. Besides changing the SLOT in the ebuild file, you also need to create a new entry in profiles/updates/ in the Gentoo repository in the following format:
slotmove app-text/gtkspell 0 2
Make sure that you have fixed all the reverse dependencies and that you have updated every file in profiles/ directory that happens to contain an entry which may be affected by your change.
When removing an ebuild make sure that no dependencies in Portage are broken due to the removal - additionally, your git commit message should explain clearly why the ebuild is being removed from the git repository.
If you need to remove ebuilds, make sure you do not accidentally remove the newest/only stable ebuild for any architecture. If you would like to get a newer version marked stable, then please file a bug or ask on IRC.
You should also not cause an unnecessary downgrade for any "
when removing ebuilds - instead, it is best to get the newest version
~arch" first and then remove redundant versions of the ebuild.
When removing packages follow these steps:
<pkg>tags referencing this package in the metadata.xml files of other packages.
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
An example commit message is shown below:
commit b97eb6d43f45dfd5b739638928db22d3f3392685 Author: Michael Palimaka <email@example.com> Date: Tue Oct 3 21:43:03 2017 +1100 dev-qt/qtphonon: remove last rited package Closes: https://bugs.gentoo.org/629144
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
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:
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
files (which should still be fixed, but aren't critical as Portage
won't overwrite them).
HOMEPAGE of your package seems to be unavailable or it
never existed at all, please set the HOMEPAGE variable in every ebuild