go-utils/sunrise-commit.1

.TH SUNRISE-COMMIT 1 "13 Jul 2010" "sunrise-commit 0.3" "User Commands"

.SH NAME

sunrise-commit \- commit changes to the Sunrise overlay.

.SH SYNOPSIS

.B sunrise-commit
[options]
[--]
.I <commit-message>

.SH DESCRIPTION

.B sunrise-commit
is a helper script for Sunrise overlay commiters. Apart from performing
the actual commit, it performs the following tasks:

\- performs basic integrity and QA checks on the modified packages,

\- handles ChangeLog and Manifest updates,

\- prepends the commit message with package name(s).

This script supports both native Subversion repositories and git-svn
checkouts. It is ready to work with the future git repository too.

Please note that, when used with git variants, this script only
performs the actual commit. (It does not push or dcommit it to the
repository). However, native Subversion commits are performed directly
on the remote repository (due to limitations of Subversion).

.SH OPTIONS

.IP "\fB-c\fP, \fB--changelog\fP"

Ignored (provided for backwards compatibility). ChangeLog entries are
now created as needed. Use \fB--trivial\fP to suppress creation of
ChangeLog entries.

.IP "\fB-C\fP, \fB--nocolor\fP"

Disable colorful output (for terminals which do not support escape
sequences).

.IP "\fB-d\fP, \fB--noupdate\fP"

Do not update and rebase the repository before proceeding with
the commit.

.IP "\fB-f\fP, \fB--force\fP"

Force proceeding with the commit even if QA violations occur. With
this option, errors from `\fIrepoman full\fP' will be ignored and
\fB--force\fP is passed to `\fIrepoman commit\fP'.

.IP "\fB-m\fP, \fB--noformat\fP"

Do not prepend the commit message with package names.

.IP "\fB-q\fP, \fB--quiet\fP"

Ignored (provided for backwards compatibility).

.IP "\fB-t\fP, \fB--trivial\fP"

Assume the changes are trivial and thus do not require a ChangeLog
entry. Examples of trivial changes include updating Manifests and
minor correction of previous ChangeLog entries.

.IP "\fB-v\fP, \fB--verbose\fP"

Enable verbose output. Useful mostly for debugging.

.IP "\fB-?\fP, \fB-h\fP, \fB--help\fP"

Print a short help message and exit.

.IP "\fB-V\fP, \fB--version\fP"

Print the version string and exit.

.SH ENVIRONMENT

.IP ECHANGELOG_USER

the committer name and e-mail as it would appear in ChangeLog.
The sunrise-suggested format is:

.IR "Real Name" " (" nickname ") <" e-mail >

`\fInickname\fP' corresponds to the committer's IRC nickname.

.SH EXAMPLES

All of the following examples assume that the committer is using a
native Subversion repository and that the initial working directory is
the branch's or repository's root.

.I "1. Adding a new ebuild:"

.nf
$ svn mkdir app-foo/bar
$ cd app-foo/bar
[...]
$ svn add bar-1.ebuild
$ sunrise-commit 'New ebuild for bug #nnnnnn.'
.fi

.I "2. Performing a version bump:"

.nf
$ cd app-foo/bar
$ svn mv bar-1.ebuild bar-2.ebuild
[...]
$ sunrise-commit 'Version bump.'
.fi

.I "3. Fixing a broken Manifest:"

.nf
$ cd app-foo/bar
$ sunrise-commit -t 'Fixing a broken Manifest.'
.fi

(\fB sunrise-commit\fP always updates the Manifest)

.I "4. Removing a package which was added to gx86:"

.nf
$ svn rm app-foo/bar
$ sunrise-commit 'in gx86.'
.fi

.SH "REPORTING BUGS"

Please report bugs via Gentoo Bugzilla:

.I http://bugs.gentoo.org/

.SH AUTHOR

Michal Gorny <gentoo@mgorny.alt.pl>

.SH "SEE ALSO"

.BR ebuild (5),
.BR echangelog (1),
.BR git (1),
.BR repoman (1),
.BR svn (1)