diff --git a/src/doc/man/sde-commit.txt b/src/doc/man/sde-commit.txt index 9851372..ff65f64 100644 --- a/src/doc/man/sde-commit.txt +++ b/src/doc/man/sde-commit.txt @@ -8,12 +8,46 @@ sde-commit - Commit changes SYNOPSIS -------- -'sde commit' [OPTIONS] +'sde commit' [DISCRIMINATORS] [OPTIONS] [ITEMS...] DESCRIPTION ----------- Commits changes to the identified part (item) within the sde environment -section indicated by the discriminator. When the user has commit rights to the -repository containing the item, using this command will indeed commit the -changes. If there are no commit rights to the repository, all changes will be -wrapped up in a patch and send to the mailing list. +section indicated by the discriminator. When the user has commit rights +to the SCM repository containing the item, using this command will indeed +commit the changes. If there are no commit rights to the repository, all +changes will be wrapped up in a patch and send to the mailing list. + +DISCRIMINATORS +-------------- + +package, pkg:: + Commits changes to the specified package(s). +repository, repo:: + Commits all modified pkgs in the specified repository. +system, sys:: + Commits all changes to the sde framework itself. For this + discriminator no items should be provided. +target, tgt:: + Commits changes to the specified target(s). + +When no discriminator is specified, package will be used as the default +discriminator. + +OPTIONS +------- + +--dry-run, -d:: + Gives feedback of what would be done, but does not really + commit. +--message, -m:: + Allows to specify the commit message on the command line. The + argument specifies the actual commit message. +--file, -f:: + Allows long commit message to be read frome file. The argument + specifies the file from which to read the message. + +EXAMPLES +-------- + + sde ci .