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

comparison mercurial/commands.py @ 6448:cd3d49ffc6f6

Consistently 1 space after full stops in command doc strings Update test output accordingly.

author	Christian Ebert <blacktrash@gmx.net>
date	Wed, 02 Apr 2008 14:03:16 +0200
parents	fa5454a451c6
children	af2edc9c5bb9

comparison

equal deleted inserted replaced

-:9d2ce19bdacd
+:cd3d49ffc6f6
 Add all new files and remove all missing files from the repository.
 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 option to detect renamed files. With a parameter > 0,
 this compares every removed file with every added file and records
-those similar enough as renames.  This option takes a percentage
+those similar enough as renames. This option takes a percentage
 between 0 (disabled) and 100 (files must be identical) as its
-parameter.  Detecting renamed files this way can be expensive.
+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'))
 '''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.
-To specify the type of archive to create, use "-t".  Valid
+To specify the type of archive to create, use "-t". Valid
 types are:
 "files" (default): a directory full of files
 "tar": tar archive, uncompressed
 "tbz2": tar archive, compressed using bzip2
 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.
+prepended. Use "-p" to specify a format string for the prefix.
 The default is the basename of the archive, with suffixes removed.
 '''
 ctx = repo.changectx(opts['rev'])
 if not ctx:
 matchfn, prefix)
 def backout(ui, repo, node=None, rev=None, **opts):
 '''reverse effect of earlier changeset
-Commit the backed out changes as a new changeset.  The new
+Commit the backed out changes as a new changeset. The new
 changeset is a child of the backed out changeset.
 If you back out a changeset other than the tip, a new head is
-created.  This head will be the new tip and you should merge this
+created. This head will be the new tip and you should merge this
 backout changeset with another head (current one by default).
 The --merge option remembers the parent of the working directory
 before starting the backout, then merges the new head with that
-changeset afterwards.  This saves you from doing the merge by
+changeset afterwards. This saves you from doing the merge by
-hand.  The result of this merge is not committed, as for a normal
+hand. The result of this merge is not committed, as for a normal
 merge.
 See 'hg help dates' for a list of formats valid for -d/--date.
 '''
 if rev and node:
 def branches(ui, repo, active=False):
 """list repository named branches
 List the repository's named branches, indicating which ones are
-inactive.  If active is specified, only show active branches.
+inactive. If active is specified, only show active branches.
 A branch is considered active if it contains unmerged heads.
 Use the command 'hg update' to switch to an existing branch.
 """
 Generate a compressed changegroup file collecting changesets not
 found in the other 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
+parameters. To create a bundle containing all changesets, use
 --all (or --base null).
 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
 Print the specified files as they were at the given revision.
 If no revision is given, the parent of the working directory is used,
 or tip if no revision is checked out.
 Output may be to a file, in which case the name of the file is
-given using a format string.  The formatting rules are the same as
+given using a format string. The formatting rules are the same as
 for the export command, with the following additions:
 %s   basename of file being printed
 %d   dirname of file being printed, or '.' if in repo root
 %p   root-relative path name of file being printed
 The location of the source is added to the new repository's
 .hg/hgrc file, as the default to be used for future pulls.
 For efficiency, hardlinks are used for cloning whenever the source
 and destination are on the same filesystem (note this applies only
-to the repository data, not to the checked out files).  Some
+to the repository data, not to the checked out files). Some
 filesystems, such as AFS, implement hardlinking incorrectly, but
-do not report errors.  In these cases, use the --pull option to
+do not report errors. In these cases, use the --pull option to
 avoid hardlinking.
 You can safely clone repositories and checked out files using full
 hardlinks with
 ui.status(_('created new head\n'))
 def copy(ui, repo, *pats, **opts):
 """mark files as copied for the next commit
-Mark dest as having copies of source files.  If dest is a
+Mark dest as having copies of source files. If dest is a
-directory, copies are put in that directory.  If dest is a file,
+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
-stand in the working directory.  If invoked with --after, the
+stand in the working directory. If invoked with --after, the
 operation is recorded, but no copying is performed.
 This command takes effect in the next commit. To undo a copy
 before that, see hg revert.
 """
 NOTE: export may generate unexpected diff output for merge changesets,
 as it will compare the merge changeset against its first parent only.
 Output may be to a file, in which case the name of the file is
-given using a format string.  The formatting rules are as follows:
+given using a format string. The formatting rules are as follows:
 %%   literal "%" character
 %H   changeset hash (40 bytes of hexadecimal)
 %N   number of patches being generated
 %R   changeset revision number
 def grep(ui, repo, pattern, *pats, **opts):
 """search for a pattern in specified files and revisions
 Search revisions of files for a regular expression.
-This command behaves differently than Unix grep.  It only accepts
+This command behaves differently than Unix grep. It only accepts
-Python/Perl regexps.  It searches repository history, not the
+Python/Perl regexps. It searches repository history, not the
-working directory.  It always prints the revision number in which
+working directory. It always prints the revision number in which
 a match appears.
 By default, grep only prints output for the first revision of a
-file in which it finds a match.  To get it to print every revision
+file in which it finds a match. To get it to print every revision
 that contains a change in match status ("-" for a match that
 becomes a non-match, or "+" for a non-match that becomes a match),
 use the --all flag.
 """
 reflags = 0
 Repository "heads" are changesets that don't have child
 changesets. They are where development generally takes place and
 are the usual targets for update and merge operations.
 Branch heads are changesets that have a given branch tag, but have
-no child changesets with that tag.  They are usually where
+no child changesets with that tag. They are usually where
 development on the given branch takes place.
 """
 if opts['rev']:
 start = repo.lookup(opts['rev'])
 else:
 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.
-You can import a patch straight from a mail message.  Even patches
+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
+text/x-patch to be used). From and Subject headers of email
-message are used as default committer and commit message.  All
+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
+from patch override values from message headers and body. Values
 given on command line with -m and -u 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
 os.unlink(cleanup)
 def init(ui, dest=".", **opts):
 """create a new repository in the given directory
-Initialize a new repository in the given directory.  If the given
+Initialize a new repository in the given directory. If the given
 directory does not exist, it is created.
 If no directory is given, the current directory is used.
 It is possible to specify an ssh:// URL as the destination.
 """locate files matching specific patterns
 Print all files under Mercurial control whose names match the
 given patterns.
-This command searches the entire repository by default.  To search
+This command searches the entire repository by default. To search
 just the current directory and its subdirectories, use
 "--include .".
 If no patterns are given to match, this command prints all file
 names.
 Print the revision history of the specified files or the entire
 project.
 File history is shown without following rename or copy history of
-files.  Use -f/--follow with a file name to follow history across
+files. Use -f/--follow with a file name to follow history across
 renames and copies. --follow without a file name will only show
 ancestors or descendants of the starting revision. --follow-first
 only follows the first parent of merge revisions.
 If no revision range is specified, the default is tip:0 unless
 marked as changed for the next commit and a commit must be
 performed before any further updates are allowed.
 If no revision is specified, the working directory's parent is a
 head revision, and the repository contains exactly one other head,
-the other head is merged with by default.  Otherwise, an explicit
+the other head is merged with by default. Otherwise, an explicit
 revision to merge with must be provided.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 Show definition of symbolic path name NAME. If no name is given, show
 definition of available names.
 Path names are defined in the [paths] section of /etc/mercurial/hgrc
-and $HOME/.hgrc.  If run inside a repository, .hg/hgrc is used, too.
+and $HOME/.hgrc. If run inside a repository, .hg/hgrc is used, too.
 """
 if search:
 for name, path in ui.configitems("paths"):
 if name == search:
 ui.write("%s\n" % util.hidepassword(path))
 repo.remove(remove, unlink=not after)
 def rename(ui, repo, *pats, **opts):
 """rename files; equivalent of copy + remove
-Mark dest as copies of sources; mark sources for deletion.  If
+Mark dest as copies of sources; mark sources for deletion. If
-dest is a directory, copies are put in that directory.  If dest is
+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
-stand in the working directory.  If invoked with --after, the
+stand in the working directory. If invoked with --after, the
 operation is recorded, but no copying is performed.
 This command takes effect in the next commit. To undo a rename
 before that, see hg revert.
 """
 Using the -r option, revert the given files or directories to their
 contents as of a specific revision. This can be helpful to "roll
 back" some or all of an earlier change.
 See 'hg help dates' for a list of formats valid for -d/--date.
-Revert modifies the working directory.  It does not commit any
+Revert modifies the working directory. It does not commit any
-changes, or change the parent of the working directory.  If you
+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
 afterwards.
-If a file has been deleted, it is restored.  If the executable
+If a file has been deleted, it is restored. If the executable
 mode of a file was changed, it is reset.
 If names are given, all files matching the names are reverted.
 If no arguments are given, no files are reverted.
 """export the repository via HTTP
 Start a local HTTP repository browser and pull server.
 By default, the server logs accesses to stdout and errors to
-stderr.  Use the "-A" and "-E" options to log to files.
+stderr. Use the "-A" and "-E" options to log to files.
 """
 if opts["stdio"]:
 if repo is None:
 raise RepoError(_("There is no Mercurial repository here"
 cmdutil.service(opts, initfn=service.init, runfn=service.run)
 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
+Show status of files in the repository. If names are given, only
-files that match are shown.  Files that are clean or ignored or
+files that match are shown. Files that are clean or ignored or
 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 is given. Unless options 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.
 or tip if no revision is checked out.
 To facilitate version control, distribution, and merging of tags,
 they are stored as a file named ".hgtags" which is managed
 similarly to other project files and can be hand-edited if
-necessary.  The file '.hg/localtags' is used for local tags (not
+necessary. The file '.hg/localtags' is used for local tags (not
 shared among repositories).
 See 'hg help dates' for a list of formats valid for -d/--date.
 """

Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/commands.py @ 6448:cd3d49ffc6f6