repoman

Warning
Usage of repoman is deprecated. It is advised to use pkgdev instead.^[1]

The information in this article is representative of former times and has been archived. It can be used for reference, but is most likely not appropriate for current usage. Generally, archived articles should not be edited.

Resources

Project

Package information

GitWeb

repoman was a Python program used to enforce a minimal level of quality assurance in ebuilds and related metadata added to ebuild repositories.

Installation

Emerge

Install repoman through emerge:

root #emerge --ask --verbose app-portage/repoman

Configuration

For signing commits, enable the sign feature for portage and set the appropriate key ID:

FILE /etc/portage/make.conf

FEATURES="... sign ..."
PORTAGE_GPG_KEY="<GnuPG fingerprint>"

Alternatively, set up git to automatically sign your commits and set the PORTAGE_GPG_DIR environment variable to point at your ~/.gnupg (or similar) before running repoman.

To automatically include Signed-off-by: Name <email> in the commit message, add:

FILE /etc/portage/make.conf

SIGNED_OFF_BY="Name <email>"

This implies agreeing to the Certificate of Origin.

Usage

Using repoman is highly recommended for committing to Gentoo with GitHub Pull Requests.

Invocation

Note
Messages pertaining to specific lines may be inaccurate in the presence of continuation lines from use of the \ character in bash.

To create a package's Manifest file:

user $repoman manifest

>>> Creating Manifest for /var/db/repos/local/app-misc/foo

Note
Signed manifests are only created during repoman commit.

To scan the directory tree for QA issues (full listing), include dev profiles in dependency checks and force the metadata.xml parse check to be carried out:

user $repoman -dx full


RepoMan scours the neighborhood...
  dependency.badindev           16
   app-text/mupdf/mupdf-1.8.ebuild: DEPEND: ~arm(default/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: RDEPEND: ~arm(default/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: DEPEND: ~ppc(default/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: RDEPEND: ~ppc(default/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: DEPEND: ~arm(hardened/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: RDEPEND: ~arm(hardened/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: DEPEND: ~ppc(hardened/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.8.ebuild: RDEPEND: ~ppc(hardened/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: DEPEND: ~arm(default/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: RDEPEND: ~arm(default/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: DEPEND: ~ppc(default/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: RDEPEND: ~ppc(default/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: DEPEND: ~arm(hardened/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: RDEPEND: ~arm(hardened/linux/uclibc/arm/armv7a)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: DEPEND: ~ppc(hardened/linux/uclibc/ppc)
['>=media-libs/glfw-3']
   app-text/mupdf/mupdf-1.9a.ebuild: RDEPEND: ~ppc(hardened/linux/uclibc/ppc)
['>=media-libs/glfw-3']
RepoMan sez: "You're only giving me a partial QA payment?
              I'll take it this time, but I'm not happy."

To scan the directory tree for QA issues; if OK, commit via VCS, include dev profiles in dependency checks and force the metadata.xml parse check to be carried out:

user $repoman -dx commit

* 0 files being committed... 
error: gpg failed to sign the data
fatal: failed to write commit object
!!! Exiting on git (shell) error code: 128

Note
repoman commit only works inside local cvs, git, or subversion repositories.

When used in git, this command forces commit signature.

The key will have to be configured by git config user.signingkey key_id.

user $repoman --help

usage: repoman [options] [mode]

Modes: ci | commit | fix | full | help | manifest | manifest-check | scan

optional arguments:
  -h, --help            show this help message and exit
  -a, --ask             Request a confirmation before commiting
  -m COMMITMSG, --commitmsg COMMITMSG
                        specify a commit message on the command line
  -M COMMITMSGFILE, --commitmsgfile COMMITMSGFILE
                        specify a path to a file that contains a commit
                        message
  --digest <y|n>        Automatically update Manifest digests for modified
                        files
  -p, --pretend         don't commit or fix anything; just show what would be
                        done
  -q, --quiet           do not print unnecessary messages
  --echangelog <y|n|force>
                        for commit mode, call echangelog if ChangeLog is
                        unmodified (or regardless of modification if 'force'
                        is specified)
  --experimental-inherit <y|n>
                        Enable experimental inherit.missing checks which may
                        misbehave when the internal eclass database becomes
                        outdated
  -f, --force           Commit with QA violations
  -S, --straight-to-stable
                        Allow committing straight to stable
  --vcs VCS             Force using specific VCS instead of autodetection
  -v, --verbose         be very verbose in output
  -V, --version         show version info
  -x, --xmlparse        forces the metadata.xml parse check to be carried out
  --if-modified <y|n>   only check packages that have uncommitted
                        modifications
  -i, --ignore-arches   ignore arch-specific failures (where arch != host)
  --ignore-default-opts
                        do not use the REPOMAN_DEFAULT_OPTS environment
                        variable
  -I, --ignore-masked   ignore masked packages (not allowed with commit mode)
  --include-arches ARCHES
                        A space separated list of arches used to filter the
                        selection of profiles for dependency checks
  -d, --include-dev     include dev profiles in dependency checks
  -e <y|n>, --include-exp-profiles <y|n>
                        include exp profiles in dependency checks
  --unmatched-removal   enable strict checking of package.mask and
                        package.unmask files for unmatched removal atoms
  --without-mask        behave as if no package.mask entries exist (not
                        allowed with commit mode)
  --output-style {column,default}
                        select output type
  --mode {ci,commit,fix,full,help,manifest,manifest-check,scan}
                        specify which mode repoman will run in (default=full)

For more help consult the man page.

Troubleshooting

"Need user access"

If repoman fails with the following obscure error message, you might have to adjust your filesystem permissions or make your user part of the portage group. See bug #574130 for details.