geos_one/go-utils
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add notes to the manpage: DVCSes will not have ChangeLogs created automatically; there is no automatic pulling for DVCSes.

Browse Source
This commit is contained in:
Nathan Phillip Brink 2010-08-25 18:52:18 -04:00
parent 08827d56e1
commit ff91dba58c
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
sunrise-commit.1
View File

@ -23,12 +23,12 @@ performing the actual commit, it performs the following tasks:
\- prepends the commit message with package name(s). \- prepends the commit message with package name(s).
The script supports GIT, Mercurial and Subversion repositories. For The script supports GIT, Mercurial, and Subversion repositories. For
the latter, it supports the native checkouts as well as git-svn. the latter, it supports native checkouts as well as git-svn.
Please note that, when used with DVCSes, this script only performs the Please note that when used with DVCSes, this script only performs the
actual commit. (It does not push or dcommit it to the repository). actual commit. (It does not push or dcommit it to the repository).
However, native Subversion commits are performed directly on the remote However, native Subversion commits are sent directly to the remote
repository (due to limitations of Subversion). repository (due to limitations of Subversion).
.SH OPTIONS .SH OPTIONS
@ -39,6 +39,14 @@ Ignored (provided for backwards compatibility). ChangeLog entries are
now created as needed. Use \fB--trivial\fP to suppress creation of now created as needed. Use \fB--trivial\fP to suppress creation of
ChangeLog entries. ChangeLog entries.
Because of the nature of DVCSes, a ChangeLog will not be created for a
new ebuild in a GIT or Mercurial repository. However, if the ebuild
already has a ChangeLog file, it will be updated. One consideration is
that if a ChangeLog file is maintained and the repository needs to be
merged after two people adjust the same ebuild, the ChangeLog will
cause merge conflicts. Also, viewing a DVCS's log does not require an
Internet connection.
.IP "\fB-C\fP, \fB--nocolor\fP" .IP "\fB-C\fP, \fB--nocolor\fP"
Disable colorful output (for terminals which do not support escape Disable colorful output (for terminals which do not support escape
@ -46,8 +54,9 @@ sequences).
.IP "\fB-d\fP, \fB--noupdate\fP" .IP "\fB-d\fP, \fB--noupdate\fP"
Do not update and rebase the repository before proceeding with Do not update and rebase the repository before proceeding with the
the commit. commit. This option only applies to Subversion repositories. It makes
no sense to automatically pull from remote DVCS repositories.
.IP "\fB-f\fP, \fB--force\fP" .IP "\fB-f\fP, \fB--force\fP"
@ -154,5 +163,6 @@ Michal Gorny <gentoo@mgorny.alt.pl>
.BR ebuild (5), .BR ebuild (5),
.BR echangelog (1), .BR echangelog (1),
.BR git (1), .BR git (1),
.BR hg (1),
.BR repoman (1), .BR repoman (1),
.BR svn (1) .BR svn (1)