From 633bb44faef130bd501ddfc4ff2a7f43c89bcd6e Mon Sep 17 00:00:00 2001 From: Nathan Phillip Brink Date: Tue, 13 Jul 2010 23:47:31 -0400 Subject: [PATCH] Some improvements to consistency and clarity for sunrise-commit(1). --- sunrise-commit.1 | 64 +++++++++++++++++++++++++----------------------- 1 file changed, 34 insertions(+), 30 deletions(-) diff --git a/sunrise-commit.1 b/sunrise-commit.1 index 5bcbc04..b0c4ee9 100644 --- a/sunrise-commit.1 +++ b/sunrise-commit.1 @@ -17,68 +17,69 @@ sunrise-commit \- commit changes to the Sunrise overlay. 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, +\- performs 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 +This 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). +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, unless \fB--trivial\fP is used +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) +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 +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' +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" -disable prepending the commit message with package names +Do not prepend the commit message with package names. .IP "\fB-q\fP, \fB--quiet\fP" -ignored (provided for backwards compatibility) +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. Such a trivial change would be a plain Manifest update, for -example +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 +Enable verbose output. Useful mostly for debugging. .IP "\fB-?\fP, \fB-h\fP, \fB--help\fP" -print a short help message and exit +Print a short help message and exit. -.IP "\fB-V\fP, \fB--version\fP +.IP "\fB-V\fP, \fB--version\fP" -print the version string and exit +Print the version string and exit. .SH ENVIRONMENT @@ -89,13 +90,13 @@ The sunrise-suggested format is: .IR "Real Name" " (" nickname ") <" e-mail > -Where `\fInickname\fP' corresponds to committer's IRC nickname. +`\fInickname\fP' corresponds to the 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. +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:" @@ -123,7 +124,7 @@ $ cd app-foo/bar $ sunrise-commit -t 'Fixing a broken Manifest.' .fi -(sunrise-commit always updates the Manifest) +(\fB sunrise-commit\fP always updates the Manifest) .I "4. Removing a package which was added to gx86:" @@ -146,4 +147,7 @@ Michal Gorny .BR ebuild (5), .BR echangelog (1), -.BR repoman (1) +.BR git (1), +.BR repoman (1), +.BR svn (1) +