First, thanks for wanting to contribute to my overlay.
This overlay respects the same rules and coding styles as the main Gentoo repository. It is recommended therefore to consult the section Maintain ebuilds of the page Contribute to Gentoo; in particular, the following pages must be read
All documentation files should be included.
If some files need additionnal build process, they should be added only when the doc
USE flag enabled.
Only EAPI=8
is allowed.
If an ebuild does not have test, it should specify RESTRICT="test"
.
Variable should be written using snake case.
Extra variable defined as global variable should be uppercase.
If this variable override an other variable among these ones, it should be prefixed by MY_
, e.g. MY_PN="${PN^^}"
.
Local variable should be lowercase and be declared as local
, e.g. local my_local_variable
.
Only AMD64 is supported in this overlay, i.e. KEYWORDS="~amd64"
or RESTRICT="-* ~amd64"
.
If you want to provide a live version of an ebuild, it is recommended to have the same ebuild for the latest version and the live one with the following pattern:
if [[ "${PV}" = 9999 ]]; then
inherit git-r3
EGIT_REPO_URI="<git URI>"
else
SRC_URI="<src URI>"
KEYWORDS="~amd64"
fi
9999
must be replaced by the appropriate format, e.g. the live version of an ebuild with the version 19700101
should be 99999999
.
The metadata file should provide as many elements as possible, in particular, <upstream>
should be as complete as possible.
If a package does not include binary files, the ebuild should include RESTRICT="binchecks test"
and <stabilize-allarches/>
in the metadata.xml file.
If a package need to be removed, it has to be masked 15 days before.
Patch files should be created with git format-patch
.
Prebuilt packages should include in their ebuild QA_PREBUILT
and, according to the redistribution rules, RESTRICT="bindist mirror"
.
Versions bumps or rebumps should replace the previous version for the current SLOT
.