mercurial-scm/hg-stable: mercurial/commands.py comparison

comparison mercurial/commands.py @ 8033:aeb4a5c7a28e

commands: consistently write switches as -a/--abc

author	Martin Geisler <mg@lazybytes.net>
date	Wed, 08 Apr 2009 21:20:31 +0200
parents	4726a522a182
children	15725dbc900f

comparison

equal deleted inserted replaced

-:4726a522a182
+:aeb4a5c7a28e
 New files are ignored if they match any of the patterns in
 .hgignore. As with add, these changes take effect at the next
 commit.
-Use the -s option to detect renamed files. With a parameter > 0,
+Use the -s/--similarity option to detect renamed files. With a
-this compares every removed file with every added file and records
+parameter > 0, this compares every removed file with every added
-those similar enough as renames. This option takes a percentage
+file and records those similar enough as renames. This option
-between 0 (disabled) and 100 (files must be identical) as its
+takes a percentage between 0 (disabled) and 100 (files must be
-parameter. Detecting renamed files this way can be expensive.
+identical) as its parameter. Detecting renamed files this way can
+be expensive.
 """
 try:
 sim = float(opts.get('similarity') or 0)
 except ValueError:
 raise util.Abort(_('similarity must be a number'))
 each line
 This command is useful to discover who did a change or when a
 change took place.
-Without the -a option, annotate will avoid processing files it
+Without the -a/--text option, annotate will avoid processing files
-detects as binary. With -a, annotate will generate an annotation
+it detects as binary. With -a, annotate will generate an
-anyway, probably with undesirable results.
+annotation anyway, probably with undesirable results.
 """
 datefunc = ui.quiet and util.shortdate or util.datestr
 getdate = util.cachefunc(lambda x: datefunc(x[0].date()))
 if not pats:
 def archive(ui, repo, dest, **opts):
 '''create unversioned archive of a repository revision
 By default, the revision used is the parent of the working
-directory; use -r to specify a different revision.
+directory; use -r/--rev to specify a different revision.
-To specify the type of archive to create, use -t. Valid types are:
+To specify the type of archive to create, use -t/--type. Valid
+types are:
 "files" (default): a directory full of files
 "tar": tar archive, uncompressed
 "tbz2": tar archive, compressed using bzip2
 "tgz": tar archive, compressed using gzip
 The exact name of the destination archive or directory is given
 using a format string; see 'hg help export' for details.
 Each member added to an archive file has a directory prefix
-prepended. Use -p to specify a format string for the prefix. The
+prepended. Use -p/--prefix to specify a format string for the
-default is the basename of the archive, with suffixes removed.
+prefix. The default is the basename of the archive, with suffixes
+removed.
 '''
 ctx = repo[opts.get('rev')]
 if not ctx:
 raise util.Abort(_('no working directory: please specify a revision'))
 This command helps to find changesets which introduce problems. To
 use, mark the earliest changeset you know exhibits the problem as
 bad, then mark the latest changeset which is free from the problem
 as good. Bisect will update your working directory to a revision
-for testing (unless the --noupdate option is specified). Once you
+for testing (unless the -U/--noupdate option is specified). Once
-have performed tests, mark the working directory as bad or good
+you have performed tests, mark the working directory as bad or
-and bisect will either update to another candidate changeset or
+good and bisect will either update to another candidate changeset
-announce that it has found the bad revision.
+or announce that it has found the bad revision.
 As a shortcut, you can also use the revision argument to mark a
 revision as good or bad without checking it out first.
 If you supply a command it will be used for automatic bisection.
 With no argument, show the current branch name. With one argument,
 set the working directory branch name (the branch does not exist
 in the repository until the next commit). It is recommended to use
 the 'default' branch as your primary development branch.
-Unless --force is specified, branch will not let you set a branch
+Unless -f/--force is specified, branch will not let you set a
-name that shadows an existing branch.
+branch name that shadows an existing branch.
-Use --clean to reset the working directory branch to that of the
+Use -C/--clean to reset the working directory branch to that of
-parent of the working directory, negating a previous branch
+the parent of the working directory, negating a previous branch
 change.
 Use the command 'hg update' to switch to an existing branch.
 """
 known to be in another repository.
 If no destination repository is specified the destination is
 assumed to have all the nodes specified by one or more --base
 parameters. To create a bundle containing all changesets, use
---all (or --base null). To change the compression method applied,
+-a/--all (or --base null). To change the compression method
-use the -t option (by default, bundles are compressed using bz2).
+applied, use the -t/--type option (by default, bundles are
+compressed using bz2).
 The bundle file can then be transferred using conventional means
 and applied to another repository with the unbundle or pull
 command. This is useful when direct push and pull are not
 available or when exporting an entire repository is undesirable.
 basename of the source.
 The location of the source is added to the new repository's
 .hg/hgrc file, as the default to be used for future pulls.
-If you use the -r option to clone up to a specific revision, no
+If you use the -r/--rev option to clone up to a specific revision,
-subsequent revisions (including subsequent tags) will be present
+no subsequent revisions (including subsequent tags) will be
-in the cloned repository. This option implies --pull, even on
+present in the cloned repository. This option implies --pull, even
-local repositories.
+on local repositories.
 By default, clone will check out the head of the 'default' branch.
-If the -U option is used, the new clone will contain only a
+If the -U/--noupdate option is used, the new clone will contain
-repository (.hg) and no working copy (the working copy parent is
+only a repository (.hg) and no working copy (the working copy
-the null revision).
+parent is the null revision).
 See 'hg help urls' for valid source format details.
 It is possible to specify an ssh:// URL as the destination, but no
 .hg/hgrc and working directory will be created on the remote side.
 Mark dest as having copies of source files. If dest is a
 directory, copies are put in that directory. If dest is a file,
 the source must be a single file.
 By default, this command copies the contents of files as they
-stand in the working directory. If invoked with --after, the
+stand in the working directory. If invoked with -A/--after, the
 operation is recorded, but no copying is performed.
 This command takes effect with the next commit. To undo a copy
 before that, see hg revert.
 """
 between those revisions. If only one revision is specified then
 that revision is compared to the working directory, and, when no
 revisions are specified, the working directory files are compared
 to its parent.
-Without the -a option, diff will avoid generating diffs of files
+Without the -a/--text option, diff will avoid generating diffs of
-it detects as binary. With -a, diff will generate a diff anyway,
+files it detects as binary. With -a, diff will generate a diff
-probably with undesirable results.
+anyway, probably with undesirable results.
-Use the --git option to generate diffs in the git extended diff
+Use the -g/--git option to generate diffs in the git extended diff
 format. For more information, read 'hg help diffs'.
 """
 revs = opts.get('rev')
 change = opts.get('change')
 %b   basename of the exporting repository
 %h   short-form changeset hash (12 bytes of hexadecimal)
 %n   zero-padded sequence number, starting at 1
 %r   zero-padded changeset revision number
-Without the -a option, export will avoid generating diffs of files
+Without the -a/--text option, export will avoid generating diffs
-it detects as binary. With -a, export will generate a diff anyway,
+of files it detects as binary. With -a, export will generate a
-probably with undesirable results.
+diff anyway, probably with undesirable results.
-Use the --git option to generate diffs in the git extended diff
+Use the -g/--git option to generate diffs in the git extended diff
 format. Read the diffs help topic for more information.
 With the --switch-parent option, the diff will be against the
 second parent. It can be useful to review a merge.
 """
 """import an ordered set of patches
 Import a list of patches and commit them individually.
 If there are outstanding changes in the working directory, import
-will abort unless given the -f flag.
+will abort unless given the -f/--force flag.
 You can import a patch straight from a mail message. Even patches
 as attachments work (body part must be type text/plain or
 text/x-patch to be used). From and Subject headers of email
 message are used as default committer and commit message. All
 text/plain body parts before first diff are added to commit
 message.
 If the imported patch was generated by hg export, user and
 description from patch override values from message headers and
-body. Values given on command line with -m and -u override these.
+body. Values given on command line with -m/--message and -u/--user
+override these.
 If --exact is specified, import will set the working directory to
 the parent of each patch before applying it, and will abort if the
 resulting changeset has a different ID than the one recorded in
 the patch. This may happen due to character set problems or other
 deficiencies in the text patch format.
-With --similarity, hg will attempt to discover renames and copies
+With -s/--similarity, hg will attempt to discover renames and
-in the patch in the same way as 'addremove'.
+copies in the patch in the same way as 'addremove'.
 To read a patch from standard input, use patch name "-". See 'hg
 help dates' for a list of formats valid for -d/--date.
 """
 patches = (patch1,) + patches
 By default this command outputs: changeset id and hash, tags,
 non-trivial parents, user, date and time, and a summary for each
 commit. When the -v/--verbose switch is used, the list of changed
 files and full commit message is shown.
-NOTE: log -p may generate unexpected diff output for merge
+NOTE: log -p/--patch may generate unexpected diff output for merge
 changesets, as it will only compare the merge changeset against
 its first parent. Also, the files: list will only reflect files
 that are different from BOTH parents.
 """
 def parents(ui, repo, file_=None, **opts):
 """show the parents of the working directory or revision
 Print the working directory's parent revisions. If a revision is
-given via --rev, the parent of that revision will be printed. If a
+given via -r/--rev, the parent of that revision will be printed.
-file argument is given, revision in which the file was last
+If a file argument is given, revision in which the file was last
 changed (before the working directory revision or the argument to
 --rev if given) is printed.
 """
 rev = opts.get('rev')
 if rev:
 By default, push will refuse to run if it detects the result would
 increase the number of remote heads. This generally indicates the
 the client has forgotten to pull and merge before pushing.
-If -r is used, the named revision and all its ancestors will be
+If -r/--rev is used, the named revision and all its ancestors will
-pushed to the remote repository.
+be pushed to the remote repository.
 Look at the help text for URLs for important details about ssh://
 URLs. If DESTINATION is omitted, a default path will be used.
 See 'hg help urls' for more information.
 """
 """remove the specified files on the next commit
 Schedule the indicated files for removal from the repository.
 This only removes files from the current branch, not from the
-entire project history. -A can be used to remove only files that
+entire project history. -A/--after can be used to remove only
-have already been deleted, -f can be used to force deletion, and
+files that have already been deleted, -f/--force can be used to
--Af can be used to remove files from the next revision without
+force deletion, and -Af can be used to remove files from the next
-deleting them.
+revision without deleting them.
 The following table details the behavior of remove for different
 file states (columns) and option combinations (rows). The file
 states are Added, Clean, Modified and Missing (as reported by hg
 status). The actions are Warn, Remove (from branch) and Delete
 Mark dest as copies of sources; mark sources for deletion. If dest
 is a directory, copies are put in that directory. If dest is a
 file, there can only be one source.
 By default, this command copies the contents of files as they
-exist in the working directory. If invoked with --after, the
+exist in the working directory. If invoked with -A/--after, the
 operation is recorded, but no copying is performed.
 This command takes effect at the next commit. To undo a rename
 before that, see hg revert.
 """
 def resolve(ui, repo, *pats, **opts):
 """retry file merges from a merge or update
 This command will cleanly retry unresolved file merges using file
 revisions preserved from the last update or merge. To attempt to
-resolve all unresolved files, use the -a switch.
+resolve all unresolved files, use the -a/--all switch.
 If a conflict is resolved manually, please note that the changes
-will be overwritten if the merge is retried with resolve. The -m
+will be overwritten if the merge is retried with resolve. The
-switch should be used to mark the file as resolved.
+-m/--mark switch should be used to mark the file as resolved.
 This command will also allow listing resolved files and manually
 marking and unmarking files as resolved. All files must be marked
 as resolved before the new commits are permitted.
 This restores the contents of the affected files to an unmodified
 state and unschedules adds, removes, copies, and renames. If the
 working directory has two parents, you must explicitly specify the
 revision to revert to.
-Using the -r option, revert the given files or directories to
+Using the -r/--rev option, revert the given files or directories
-their contents as of a specific revision. This can be helpful to
+to their contents as of a specific revision. This can be helpful
-"roll back" some or all of an earlier change. See 'hg help dates'
+to "roll back" some or all of an earlier change. See 'hg help
-for a list of formats valid for -d/--date.
+dates' for a list of formats valid for -d/--date.
 Revert modifies the working directory. It does not commit any
 changes, or change the parent of the working directory. If you
 revert to a revision other than the parent of the working
 directory, the reverted files will thus appear modified
 def status(ui, repo, *pats, **opts):
 """show changed files in the working directory
 Show status of files in the repository. If names are given, only
 files that match are shown. Files that are clean or ignored or
-source of a copy/move operation, are not listed unless -c (clean),
+source of a copy/move operation, are not listed unless -c/--clean,
--i (ignored), -C (copies) or -A is given. Unless options described
+-i/--ignored, -C/--copies or -A/--all is given. Unless options
-with "show only ..." are given, the options -mardu are used.
+described with "show only ..." are given, the options -mardu are
+used.
 Option -q/--quiet hides untracked (unknown and ignored) files
 unless explicitly requested with -u/--unknown or -i/--ignored.
 NOTE: status may appear to disagree with diff if permissions have
 suggestion to use 'merge' or 'update -C' instead.
 If you want to update just one file to an older revision, use
 revert.
-See 'hg help dates' for a list of formats valid for --date.
+See 'hg help dates' for a list of formats valid for -d/--date.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 if not rev:

Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/commands.py @ 8033:aeb4a5c7a28e