.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 the basic integrity and QA checks on the modified packages,

\- handles ChangeLog and Manifest updates,

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

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

Please notice that while with git variants, the script itself does
perform the actual commit only (and does not push/dcommit it
to the repository), the native Subversion commits are performed directly
to 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, unless \fB--trivial\fP is used

.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. This
means ignoring `\fIrepoman full\fP' results and passing \fB--force\fP to
`\fIrepoman commit\fP'

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

assume the changes are trivial and thus do not require a ChangeLog
entry. Such a trivial change would be a plain Manifest update, for
example

.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 >

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

.SH EXAMPLES

All the following examples assume the committer is using native
Subversion repository and the current working directory is the branch
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

(sunrise-commit 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 repoman (1)