help.py
421 lines
| 16.7 KiB
| text/x-python
|
PythonLexer
/ mercurial / help.py
|
r3795 | # help.py - help data for mercurial | ||
# | ||||
# Copyright 2006 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
# GNU General Public License version 2, incorporated herein by reference. | ||||
|
r3795 | |||
|
r7013 | from i18n import _ | ||
|
r6654 | helptable = ( | ||
|
r7013 | (["dates"], _("Date Formats"), | ||
_(r''' | ||||
|
r7764 | Some commands allow the user to specify a date, e.g.: | ||
* backout, commit, import, tag: Specify the commit date. | ||||
* log, revert, update: Select revision(s) by date. | ||||
|
r6163 | |||
Many date formats are valid. Here are some examples: | ||||
|
r3795 | |||
|
r3811 | "Wed Dec 6 13:18:29 2006" (local timezone assumed) | ||
"Dec 6 13:18 -0600" (year assumed, time offset provided) | ||||
"Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000) | ||||
"Dec 6" (midnight) | ||||
"13:18" (today assumed) | ||||
"3:39" (3:39AM assumed) | ||||
"3:39pm" (15:39) | ||||
|
r6773 | "2006-12-06 13:18:29" (ISO 8601 format) | ||
|
r3811 | "2006-12-6 13:18" | ||
"2006-12-6" | ||||
"12-6" | ||||
"12/6" | ||||
"12/6/6" (Dec 6 2006) | ||||
|
r3795 | |||
|
r3811 | Lastly, there is Mercurial's internal format: | ||
|
r3795 | |||
|
r3811 | "1165432709 0" (Wed Dec 6 13:18:29 2006 UTC) | ||
|
r3795 | |||
This is the internal representation format for dates. unixtime is | ||||
|
r8005 | the number of seconds since the epoch (1970-01-01 00:00 UTC). | ||
offset is the offset of the local timezone, in seconds west of UTC | ||||
(negative if the timezone is east of UTC). | ||||
|
r6163 | |||
The log command also accepts date ranges: | ||||
|
r7804 | "<{datetime}" - at or before a given date/time | ||
">{datetime}" - on or after a given date/time | ||||
"{datetime} to {datetime}" - a date range, inclusive | ||||
|
r6163 | "-{days}" - within a given number of days of today | ||
|
r7013 | ''')), | ||
|
r6654 | |||
|
r7013 | (["patterns"], _("File Name Patterns"), | ||
_(r''' | ||||
|
r6654 | Mercurial accepts several notations for identifying one or more | ||
files at a time. | ||||
By default, Mercurial treats filenames as shell-style extended | ||||
glob patterns. | ||||
Alternate pattern notations must be specified explicitly. | ||||
|
r7804 | To use a plain path name without any pattern matching, start it | ||
|
r7808 | with "path:". These path names must completely match starting at | ||
|
r7804 | the current repository root. | ||
|
r6654 | |||
|
r7808 | To use an extended glob, start a name with "glob:". Globs are | ||
|
r7804 | rooted at the current directory; a glob such as "*.c" will only | ||
match files in the current directory ending with ".c". | ||||
|
r6654 | |||
The supported glob syntax extensions are "**" to match any string | ||||
|
r7804 | across path separators and "{a,b}" to mean "a or b". | ||
|
r3799 | |||
|
r6654 | To use a Perl/Python regular expression, start a name with "re:". | ||
Regexp pattern matching is anchored at the root of the repository. | ||||
Plain examples: | ||||
path:foo/bar a name bar in a directory named foo in the root of | ||||
the repository | ||||
path:path:name a file or directory named "path:name" | ||||
Glob examples: | ||||
glob:*.c any name ending in ".c" in the current directory | ||||
*.c any name ending in ".c" in the current directory | ||||
|
r7804 | **.c any name ending in ".c" in any subdirectory of the | ||
current directory including itself. | ||||
|
r6654 | foo/*.c any name ending in ".c" in the directory foo | ||
|
r7804 | foo/**.c any name ending in ".c" in any subdirectory of foo | ||
including itself. | ||||
|
r6654 | |||
Regexp examples: | ||||
re:.*\.c$ any name ending in ".c", anywhere in the repository | ||||
|
r7013 | ''')), | ||
|
r6654 | |||
|
r7013 | (['environment', 'env'], _('Environment Variables'), | ||
_(r''' | ||||
|
r4686 | HG:: | ||
|
r8005 | Path to the 'hg' executable, automatically passed when running | ||
hooks, extensions or external tools. If unset or empty, this is | ||||
the hg executable's name if it's frozen, or an executable named | ||||
'hg' (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on | ||||
|
r7804 | Windows) is searched. | ||
|
r4686 | |||
|
r3798 | HGEDITOR:: | ||
|
r7804 | This is the name of the editor to run when committing. See EDITOR. | ||
|
r3798 | |||
(deprecated, use .hgrc) | ||||
HGENCODING:: | ||||
This overrides the default locale setting detected by Mercurial. | ||||
This setting is used to convert data including usernames, | ||||
changeset descriptions, tag names, and branches. This setting can | ||||
be overridden with the --encoding command-line option. | ||||
HGENCODINGMODE:: | ||||
This sets Mercurial's behavior for handling unknown characters | ||||
|
r7804 | while transcoding user input. The default is "strict", which | ||
causes Mercurial to abort if it can't map a character. Other | ||||
|
r3798 | settings include "replace", which replaces unknown characters, and | ||
"ignore", which drops them. This setting can be overridden with | ||||
the --encodingmode command-line option. | ||||
HGMERGE:: | ||||
An executable to use for resolving merge conflicts. The program | ||||
will be executed with three arguments: local file, remote file, | ||||
ancestor file. | ||||
(deprecated, use .hgrc) | ||||
HGRCPATH:: | ||||
|
r7808 | A list of files or directories to search for hgrc files. Item | ||
separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, | ||||
platform default search path is used. If empty, only the .hg/hgrc | ||||
|
r7804 | from the current repository is read. | ||
|
r3798 | |||
|
r7805 | For each element in HGRCPATH: | ||
|
r7904 | * if it's a directory, all files ending with .rc are added | ||
* otherwise, the file itself will be added | ||||
|
r3798 | |||
HGUSER:: | ||||
|
r7805 | This is the string used as the author of a commit. If not set, | ||
available values will be considered in this order: | ||||
* HGUSER (deprecated) | ||||
* hgrc files from the HGRCPATH | ||||
* interactive prompt | ||||
* LOGNAME (with '@hostname' appended) | ||||
|
r3798 | |||
(deprecated, use .hgrc) | ||||
EMAIL:: | ||||
|
r7805 | May be used as the author of a commit; see HGUSER. | ||
|
r3798 | |||
LOGNAME:: | ||||
|
r7805 | May be used as the author of a commit; see HGUSER. | ||
|
r3798 | |||
|
r5660 | VISUAL:: | ||
This is the name of the editor to use when committing. See EDITOR. | ||||
|
r3798 | EDITOR:: | ||
|
r8005 | Sometimes Mercurial needs to open a text file in an editor for a | ||
user to modify, for example when writing commit messages. The | ||||
editor it uses is determined by looking at the environment | ||||
|
r6009 | variables HGEDITOR, VISUAL and EDITOR, in that order. The first | ||
non-empty one is chosen. If all of them are empty, the editor | ||||
|
r5660 | defaults to 'vi'. | ||
|
r3798 | |||
PYTHONPATH:: | ||||
|
r8005 | This is used by Python to find imported modules and may need to be | ||
set appropriately if this Mercurial is not installed system-wide. | ||||
|
r7013 | ''')), | ||
|
r6655 | |||
|
r7013 | (['revs', 'revisions'], _('Specifying Single Revisions'), | ||
_(r''' | ||||
|
r8005 | Mercurial supports several ways to specify individual revisions. | ||
|
r6655 | |||
|
r8005 | A plain integer is treated as a revision number. Negative integers | ||
are treated as topological offsets from the tip, with -1 denoting | ||||
the tip. As such, negative numbers are only useful if you've | ||||
memorized your local tree numbers and want to save typing a single | ||||
digit. This editor suggests copy and paste. | ||||
|
r6655 | |||
A 40-digit hexadecimal string is treated as a unique revision | ||||
identifier. | ||||
A hexadecimal string less than 40 characters long is treated as a | ||||
unique revision identifier, and referred to as a short-form | ||||
identifier. A short-form identifier is only valid if it is the | ||||
|
r7804 | prefix of exactly one full-length identifier. | ||
|
r6655 | |||
Any other string is treated as a tag name, which is a symbolic | ||||
name associated with a revision identifier. Tag names may not | ||||
contain the ":" character. | ||||
The reserved name "tip" is a special tag that always identifies | ||||
the most recent revision. | ||||
The reserved name "null" indicates the null revision. This is the | ||||
revision of an empty repository, and the parent of revision 0. | ||||
The reserved name "." indicates the working directory parent. If | ||||
|
r8005 | no working directory is checked out, it is equivalent to null. If | ||
an uncommitted merge is in progress, "." is the revision of the | ||||
first parent. | ||||
|
r7013 | ''')), | ||
|
r6655 | |||
|
r7013 | (['mrevs', 'multirevs'], _('Specifying Multiple Revisions'), | ||
_(r''' | ||||
|
r6655 | When Mercurial accepts more than one revision, they may be | ||
|
r7804 | specified individually, or provided as a topologically continuous | ||
range, separated by the ":" character. | ||||
|
r6655 | |||
The syntax of range notation is [BEGIN]:[END], where BEGIN and END | ||||
are revision identifiers. Both BEGIN and END are optional. If | ||||
BEGIN is not specified, it defaults to revision number 0. If END | ||||
|
r8005 | is not specified, it defaults to the tip. The range ":" thus means | ||
"all revisions". | ||||
|
r6655 | |||
If BEGIN is greater than END, revisions are treated in reverse | ||||
order. | ||||
A range acts as a closed interval. This means that a range of 3:5 | ||||
|
r7804 | gives 3, 4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6. | ||
|
r7013 | ''')), | ||
|
r7293 | |||
|
r7387 | (['diffs'], _('Diff Formats'), | ||
|
r7293 | _(r''' | ||
|
r8005 | Mercurial's default format for showing changes between two | ||
versions of a file is compatible with the unified format of GNU | ||||
diff, which can be used by GNU patch and many other standard | ||||
tools. | ||||
|
r7293 | |||
|
r7387 | While this standard format is often enough, it does not encode the | ||
following information: | ||||
|
r7328 | |||
|
r7804 | - executable status and other permission bits | ||
|
r7328 | - copy or rename information | ||
- changes in binary files | ||||
- creation or deletion of empty files | ||||
|
r7293 | |||
|
r7387 | Mercurial also supports the extended diff format from the git VCS | ||
which addresses these limitations. The git diff format is not | ||||
|
r7804 | produced by default because a few widespread tools still do not | ||
|
r7387 | understand this format. | ||
|
r7328 | |||
|
r7387 | This means that when generating diffs from a Mercurial repository | ||
|
r7328 | (e.g. with "hg export"), you should be careful about things like | ||
file copies and renames or other things mentioned above, because | ||||
|
r8005 | when applying a standard diff to a different repository, this | ||
extra information is lost. Mercurial's internal operations (like | ||||
push and pull) are not affected by this, because they use an | ||||
internal binary format for communicating changes. | ||||
|
r7328 | |||
To make Mercurial produce the git extended diff format, use the | ||||
|
r8005 | --git option available for many commands, or set 'git = True' in | ||
the [diff] section of your hgrc. You do not need to set this | ||||
option when importing diffs in this format or using them in the mq | ||||
extension. | ||||
|
r7293 | ''')), | ||
|
r7678 | (['templating'], _('Template Usage'), | ||
|
r7677 | _(r''' | ||
Mercurial allows you to customize output of commands through | ||||
|
r8005 | templates. You can either pass in a template from the command | ||
line, via the --template option, or select an existing | ||||
template-style (--style). | ||||
|
r7677 | |||
|
r8005 | You can customize output for any "log-like" command: log, | ||
outgoing, incoming, tip, parents, heads and glog. | ||||
|
r7677 | |||
|
r7678 | Three styles are packaged with Mercurial: default (the style used | ||
|
r8005 | when no explicit preference is passed), compact and changelog. | ||
Usage: | ||||
|
r7677 | |||
|
r7678 | $ hg log -r1 --style changelog | ||
|
r7677 | |||
|
r8005 | A template is a piece of text, with markup to invoke variable | ||
expansion: | ||||
|
r7678 | |||
$ hg log -r1 --template "{node}\n" | ||||
|
r7677 | b56ce7b07c52de7d5fd79fb89701ea538af65746 | ||
|
r7678 | Strings in curly braces are called keywords. The availability of | ||
|
r8005 | keywords depends on the exact context of the templater. These | ||
keywords are usually available for templating a log-like command: | ||||
|
r7677 | |||
- author: String. The unmodified author of the changeset. | ||||
- branches: String. The name of the branch on which the changeset | ||||
was committed. Will be empty if the branch name was default. | ||||
- date: Date information. The date when the changeset was committed. | ||||
- desc: String. The text of the changeset description. | ||||
|
r8005 | - diffstat: String. Statistics of changes with the following | ||
format: "modified files: +added/-removed lines" | ||||
|
r7677 | - files: List of strings. All files modified, added, or removed by | ||
this changeset. | ||||
- file_adds: List of strings. Files added by this changeset. | ||||
|
r7678 | - file_mods: List of strings. Files modified by this changeset. | ||
|
r7677 | - file_dels: List of strings. Files removed by this changeset. | ||
|
r8005 | - node: String. The changeset identification hash, as a | ||
40-character hexadecimal string. | ||||
|
r7677 | - parents: List of strings. The parents of the changeset. | ||
- rev: Integer. The repository-local changeset revision number. | ||||
- tags: List of strings. Any tags associated with the changeset. | ||||
|
r7678 | The "date" keyword does not produce human-readable output. If you | ||
|
r8005 | want to use a date in your output, you can use a filter to process | ||
it. Filters are functions which return a string based on the input | ||||
variable. You can also use a chain of filters to get the desired | ||||
output: | ||||
|
r7677 | |||
|
r7678 | $ hg tip --template "{date|isodate}\n" | ||
|
r7677 | 2008-08-21 18:22 +0000 | ||
List of filters: | ||||
|
r7678 | - addbreaks: Any text. Add an XHTML "<br />" tag before the end of | ||
|
r7677 | every line except the last. | ||
|
r7806 | - age: Date. Returns a human-readable date/time difference between | ||
the given date/time and the current date/time. | ||||
|
r7678 | - basename: Any text. Treats the text as a path, and returns the | ||
|
r7806 | last component of the path after splitting by the path | ||
|
r8668 | separator (ignoring trailing separators). For example, | ||
|
r7806 | "foo/bar/baz" becomes "baz" and "foo/bar//" becomes "bar". | ||
|
r8159 | - stripdir: Treat the text as path and strip a directory level, if | ||
possible. For example, "foo" and "foo/bar" becomes "foo". | ||||
|
r7806 | - date: Date. Returns a date in a Unix date format, including | ||
|
r7678 | the timezone: "Mon Sep 04 15:13:13 2006 0700". | ||
|
r8005 | - domain: Any text. Finds the first string that looks like an | ||
email address, and extracts just the domain component. | ||||
|
r7806 | Example: 'User <user@example.com>' becomes 'example.com'. | ||
|
r8005 | - email: Any text. Extracts the first string that looks like an | ||
email address. Example: 'User <user@example.com>' becomes | ||||
|
r7806 | 'user@example.com'. | ||
|
r7678 | - escape: Any text. Replaces the special XML/XHTML characters "&", | ||
|
r7677 | "<" and ">" with XML entities. | ||
|
r7678 | - fill68: Any text. Wraps the text to fit in 68 columns. | ||
- fill76: Any text. Wraps the text to fit in 76 columns. | ||||
- firstline: Any text. Returns the first line of text. | ||||
|
r8237 | - nonempty: Any text. Returns '(none)' if the string is empty. | ||
|
r7678 | - hgdate: Date. Returns the date as a pair of numbers: | ||
"1157407993 25200" (Unix timestamp, timezone offset). | ||||
- isodate: Date. Returns the date in ISO 8601 format. | ||||
|
r8591 | - localdate: Date. Converts a date to local date. | ||
|
r8005 | - obfuscate: Any text. Returns the input text rendered as a | ||
sequence of XML entities. | ||||
|
r7678 | - person: Any text. Returns the text before an email address. | ||
- rfc822date: Date. Returns a date using the same format used | ||||
|
r7677 | in email headers. | ||
|
r8005 | - short: Changeset hash. Returns the short form of a changeset | ||
hash, i.e. a 12-byte hexadecimal string. | ||||
|
r7806 | - shortdate: Date. Returns a date like "2006-09-18". | ||
|
r7678 | - strip: Any text. Strips all leading and trailing whitespace. | ||
|
r8005 | - tabindent: Any text. Returns the text, with every line except | ||
the first starting with a tab character. | ||||
- urlescape: Any text. Escapes all "special" characters. For | ||||
example, "foo bar" becomes "foo%20bar". | ||||
|
r7678 | - user: Any text. Returns the user portion of an email address. | ||
|
r7677 | ''')), | ||
|
r7693 | |||
|
r7979 | (['urls'], _('URL Paths'), | ||
|
r7693 | _(r''' | ||
Valid URLs are of the form: | ||||
local/filesystem/path (or file://local/filesystem/path) | ||||
http://[user[:pass]@]host[:port]/[path] | ||||
https://[user[:pass]@]host[:port]/[path] | ||||
ssh://[user[:pass]@]host[:port]/[path] | ||||
Paths in the local filesystem can either point to Mercurial | ||||
repositories or to bundle files (as created by 'hg bundle' or | ||||
'hg incoming --bundle'). | ||||
An optional identifier after # indicates a particular branch, tag, | ||||
|
r7804 | or changeset to use from the remote repository. | ||
|
r7693 | |||
Some features, such as pushing to http:// and https:// URLs are | ||||
|
r8005 | only possible if the feature is explicitly enabled on the remote | ||
Mercurial server. | ||||
|
r7693 | |||
Some notes about using SSH with Mercurial: | ||||
|
r8005 | - SSH requires an accessible shell account on the destination | ||
machine and a copy of hg in the remote path or specified with as | ||||
remotecmd. | ||||
|
r7693 | - path is relative to the remote user's home directory by default. | ||
Use an extra slash at the start of a path to specify an absolute path: | ||||
ssh://example.com//tmp/repository | ||||
|
r8005 | - Mercurial doesn't use its own compression via SSH; the right | ||
thing to do is to configure it in your ~/.ssh/config, e.g.: | ||||
|
r7693 | Host *.mylocalnetwork.example.com | ||
Compression no | ||||
Host * | ||||
Compression yes | ||||
|
r8005 | Alternatively specify "ssh -C" as your ssh command in your hgrc | ||
or with the --ssh command line option. | ||||
|
r7693 | |||
|
r8005 | These URLs can all be stored in your hgrc with path aliases under | ||
the [paths] section like so: | ||||
|
r7693 | [paths] | ||
alias1 = URL1 | ||||
alias2 = URL2 | ||||
... | ||||
|
r8005 | You can then use the alias for any command that uses a URL (for | ||
example 'hg pull alias1' would pull from the 'alias1' path). | ||||
|
r7693 | |||
|
r7804 | Two path aliases are special because they are used as defaults | ||
|
r7979 | when you do not provide the URL to a command: | ||
|
r7693 | |||
default: | ||||
|
r8005 | When you create a repository with hg clone, the clone command | ||
saves the location of the source repository as the new | ||||
repository's 'default' path. This is then used when you omit | ||||
path from push- and pull-like commands (including incoming and | ||||
outgoing). | ||||
|
r7693 | |||
default-push: | ||||
The push command will look for a path named 'default-push', and | ||||
prefer it over 'default' if both are defined. | ||||
''')), | ||||
|
r6654 | ) | ||