6 Ebuild Tools
6.1 Package creation tools
6.1.1 GitHost2Metadata
(require ebuild/tools/githost2metadata-exe) | |
package: ebuild-tools |
6.1.1.1 About
Create a PMS package metadata file from Git hosting service repository.
6.1.1.2 Console usage
--c or --create —
create (save) the metadata --s or --show —
show (display) the metadata --d ‹directory-path› or --dir ‹directory-path› —
directory where the created metadata file should be saved -v or --verbose —
be verbose (detailed console output) -q --quiet —
be quiet (minimal/no console output) -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
githost2metadata also expects two arguments given last in the command invocation. First is the git hosting domain (e.g.: github.com, gitlab.com, ...). Second is the repository path (e.g.: xgqt/racket-ebuild, gentoo/gentoo, ...).
6.1.2 Interactive
(require ebuild/tools/interactive-exe) | |
package: ebuild-tools |
6.1.2.1 About
Interactively creates packages.
6.1.2.2 Console usage
-h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.1.3 UL2PKG
(require ebuild/tools/url2pkg-exe) | package: ebuild-tools |
6.1.3.1 About
Creates a package from given URL based on different heuristic tactics.
Quality: very experimental.
6.1.3.2 Console usage
--pn ‹package-name› or --package-name ‹package-name› —
package name --pv ‹package-version› or --package-version ‹package-version› —
package version --save —
save generated package --show —
show generated package -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.2 Repository maintenance tools
6.2.1 Clean Versions
(require ebuild/tools/clean-versions-exe) | |
package: ebuild-tools |
6.2.1.1 About
Cleans up old versions of ebuilds from a repository.
6.2.1.2 Console usage
-m ‹number› or --max ‹number› —
maximum number of ebuilds to keep -r ‹path› or --repository ‹path› —
directory path to ebuild repository -s or --simulate —
simulate, show only what would be deleted -n or --no-simulate —
do not simulate, delete the files (defaults to current unless a directory is specified by --repository) -q --quiet —
be quiet (minimal/no console output) -v or --verbose —
be verbose (detailed console output) -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.2.2 Commit
(require ebuild/tools/commit-exe) | package: ebuild-tools |
6.2.2.1 About
Create a commit.
This utility is inspired by repoman commit and new utility meant to take place of repoman - pkgdev commit.
6.2.2.2 Console usage
--m ‹commit-message› or --–message ‹commit-message› —
specify the main commit message --M ‹commit-message› or --–aux-message ‹commit-message› —
specify the auxiliary commit message, auto-line-wrapped --b ‹gentoo-bug/url› or --–bug ‹gentoo-bug/url› —
add "Bug" tag for a given Gentoo or upstream bug/URL --c ‹gentoo-bug/url› or --–closes ‹gentoo-bug/url› —
add "Closes" tag for a given Gentoo or upstream bug/URL --d or --–dry-run —
do not make commits --e or --–edit —
force editing the commit even if message is not empty --E or --–editor —
overwrite the EDITOR environment variable, EDITOR is used to edit the commit message when --–edit flag is enabled --a or --–all —
stage all changed/new/removed files --u or --–update —
stage all changed files --T or --–test-build —
test modified, staged ebuilds by executing their test phases, produces a lot of noise and requires portage user privileges and that the user is in portage group --s or --–scan —
scan using "pkgcheck" --n or --–scan-nonfatal —
do not fail when scanning with "pkgcheck" --k or --–ask-continue —
ask whether user wants to continue after failed "pkgcheck" scan, only effective if both --–scan and --–scan-nonfatal flags are enabled --U or --–update-manifests —
update Manifest files --S or --–sign —
sign the created commit --B ‹package-version› or --–bump ‹package-version› —
set the commit message to "bump to ‹package-version›" (use when updating ebuilds) --–bump-copy —
if doing a package bump, copy the latest ebuild as that version, works only in conjunction with the --B / --–bump flag --D ‹package-version› or --–drop ‹package-version› —
set the commit message to "drop old ‹package-version›" (use when removing ebuilds) --–drop-remove —
if doing a package drop, remove the specified ebuild version, works only in conjunction with the --D / --–drop flag -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.2.3 Fix Head
(require ebuild/tools/fix-head-exe) | package: ebuild-tools |
6.2.3.1 About
Fix the header of given Ebuild files.
6.2.3.2 Console usage
-h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.2.4 Manifest
(require ebuild/tools/manifest-exe) | package: ebuild-tools |
6.2.4.1 About
Regenerate Manifest files in given directories.
This program uses the ebuild command (that is included in portage).
6.2.4.2 Console usage
-f or --force —
force regeneration of distfiles -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.2.5 Modify metadata
(require ebuild/tools/modify-metadata-exe) | |
package: ebuild-tools |
6.2.5.1 About
Modify metadata.xml files.
6.2.5.2 Console usage
-a ‹name› ‹contents› or --add ‹name› ‹contents› —
add a field of name with contents -r ‹name› or --remove ‹name› —
remove a field with name -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
6.2.6 PKGName
(require ebuild/tools/pkgname-exe) | package: ebuild-tools |
6.2.6.1 About
Shows package name for a given directory.
6.2.6.2 Console usage
-c or --no-category —
do not show package categories -D or --debug —
run with debugging turned on -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program
Also takes any number of of arguments not followed by flags that specify system paths to be passed to "pkgname".
6.3 Miscellaneous tools
6.3.1 Dispatcher (racket-ebuild)
(require ebuild/tools/dispatcher-exe) | |
package: ebuild-tools |
6.3.1.1 About
Invoked from command-line as racket-ebuild.
Dispatcher calls a Racket-Ebuild sub-command given as 1st argument with rest leftover arguments, similar to how git calls it’s sub-commands.
For example: when calling racket-ebuild commit -s the dispatcher will execute racket-ebuild-commit -s.
6.3.1.2 Console usage
-l or --list —
list available subcommands -h or --help —
show help information with usage options and exit -V or --version —
show the version of this program