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

Add detailed scenario descriptions.

Browse Source
This commit is contained in:
Michał Górny 2010-10-30 21:28:35 +02:00
parent 76e0af1e25
commit b0ec712f33
1 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
sunrise-commit.1.in
View File

@ -101,6 +101,50 @@ The sunrise-suggested format is:
`\fInickname\fP' corresponds to the committer's IRC nickname. `\fInickname\fP' corresponds to the committer's IRC nickname.
.SH "EXTENDED DESCRIPTION"
.IP "Adding packages"
The primary use of sunrise-commit is to commit packages to a repository.
In order to use it in this scenario, you are expected to run it from
within the package directory (one with the ebuilds), providing
an appropriate changelog message.
If your package requires an additional file to be committed outside
the package directory (e.g. an eclass, a license) you need to commit it
manually \fBbefore\fP using sunrise-commit.
What sunrise-commit will do for you is the ChangeLog entry and calling
repoman to do the actual commit. If you think your commit doesn't
deserve a ChangeLog entry, use \fB--trivial\fP.
If you're adding a new package, it may be also necessary to use
\fB--noupdate\fP to avoid calling VCS update command as it could fail
with a freshly created directory (especially with subversion).
.IP "Removing packages"
sunrise-commit can be used to remove a set of packages too. In order to
do so, first mark all the expected packages removed using your VCS.
Perform the necessary \fBpackage.mask\fP changes too, and remove
licenses no longer in use.
Afterwards, call \fBsunrise-commit\fP from within your repository root
directory, passing the removal reason. The script will prepend it with
the complete removed package list.
Please notice that it will commit all changes in \fBeclass\fP,
\fBlicenses\fP and \fBprofiles\fP directories too. This is in order to
accomodate the need of removing \fBpackage.mask\fP entries and unused
files but could cause trouble if the working copy is dirty.
sunrise-commit will check whether the removed package is not referenced
by any of the other packages by default. This is in order to ensure that
no package will be left with unsatisfied dependencies. However, if
you're removing the package because it was moved to a master repository
(e.g. gx86), you may want to pass \fB--force\fP in order to ignore that
check.
.SH EXAMPLES .SH EXAMPLES
All of the following examples assume that the committer is using a All of the following examples assume that the committer is using a