Mercurial > hg-stable
changeset 26182:6832ba528d1a
help/config: make defaults consistent
| author | timeless@mozdev.org |
|---|---|
| date | Wed, 02 Sep 2015 13:39:46 -0400 |
| parents | c16f071f048e |
| children | bf1b24785f13 |
| files | mercurial/help/config.txt tests/test-help.t |
| diffstat | 2 files changed, 104 insertions(+), 102 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/help/config.txt Wed Sep 02 02:05:32 2015 -0400 +++ b/mercurial/help/config.txt Wed Sep 02 13:39:46 2015 -0400 @@ -348,7 +348,7 @@ authentication entry with. Only used if the prefix doesn't include a scheme. Supported schemes are http and https. They will match static-http and static-https respectively, as well. - Default: https. + (default: https) If no suitable authentication entry is found, the user is prompted for credentials as usual if required by the remote. @@ -601,8 +601,8 @@ containing patches of outgoing messages will be encoded in the first character set to which conversion from local encoding (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct - conversion fails, the text in question is sent as is. Defaults to - empty (explicit) list. + conversion fails, the text in question is sent as is. + (default: '') Order of outgoing email character sets: @@ -955,7 +955,7 @@ ``always`` Optional. Always use the proxy, even for localhost and any entries - in ``http_proxy.no``. True or False. Default: False. + in ``http_proxy.no``. True or False. (default: False) ``merge-patterns`` ------------------ @@ -1001,12 +1001,12 @@ ``priority`` The priority in which to evaluate this tool. - Default: 0. + (default: 0) ``executable`` Either just the name of the executable or its pathname. On Windows, the path can use environment variables with ${ProgramFiles} syntax. - Default: the tool name. + (default: the tool name) ``args`` The arguments to pass to the tool executable. You can refer to the @@ -1018,7 +1018,7 @@ to or the commit you are merging with. During a rebase ``$local`` represents the destination of the rebase, and ``$other`` represents the commit being rebased. - Default: ``$local $base $other`` + (default: ``$local $base $other``) ``premerge`` Attempt to run internal non-interactive 3-way merge tool before @@ -1027,15 +1027,14 @@ premerge fails. The ``keep-merge3`` will do the same but include information about the base of the merge in the marker (see internal :merge3 in :hg:`help merge-tools`). - Default: True + (default: True) ``binary`` - This tool can merge binary files. Defaults to False, unless tool - was selected by file pattern match. + This tool can merge binary files. (default: False, unless tool + was selected by file pattern match) ``symlink`` - This tool can merge symlinks. Defaults to False, even if tool was - selected by file pattern match. + This tool can merge symlinks. (default: False) ``check`` A list of merge success-checking options:: @@ -1049,32 +1048,32 @@ ``fixeol`` Attempt to fix up EOL changes caused by the merge tool. - Default: False + (default: False) ``gui`` - This tool requires a graphical interface to run. Default: False + This tool requires a graphical interface to run. (default: False) ``regkey`` Windows registry key which describes install location of this tool. Mercurial will search for this key first under ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. - Default: None + (default: None) ``regkeyalt`` An alternate Windows registry key to try if the first key is not found. The alternate key uses the same ``regname`` and ``regappend`` semantics of the primary key. The most common use for this key is to search for 32bit applications on 64bit operating systems. - Default: None + (default: None) ``regname`` - Name of value to read from specified registry key. Defaults to the - unnamed (default) value. + Name of value to read from specified registry key. + (default: the unnamed (default) value) ``regappend`` String to append to the value read from the registry, typically the executable name of the tool. - Default: None + (default: None) ``patch`` @@ -1092,13 +1091,13 @@ endings in patched files are normalized to their original setting on a per-file basis. If target file does not exist or has no end of line, patch line endings are preserved. - Default: strict. + (default: strict) ``fuzz`` The number of lines of 'fuzz' to allow when applying patches. This controls how much context the patcher is allowed to ignore when trying to apply a patch. - Default: 2 + (default: 2) ``paths`` --------- @@ -1110,8 +1109,7 @@ ``default`` Directory or URL to use when pulling if no source is specified. - Default is set to repository from which the current repository was - cloned. + (default: repository from which the current repository was cloned) ``default-push`` Optional. Directory or URL to use when pushing if no destination @@ -1138,11 +1136,11 @@ Controls draft phase behavior when working as a server. When true, pushed changesets are set to public in both client and server and pulled or cloned changesets are set to public in the client. - Default: True + (default: True) ``new-commit`` Phase of newly-created commits. - Default: draft + (default: draft) ``checksubrepos`` Check the phase of the current revision of each subrepository. Allowed @@ -1153,7 +1151,7 @@ "secret" phase while the parent repo is in "draft" phase), the commit is either aborted (if checksubrepos is set to "abort") or the higher phase is used for the parent repository commit (if set to "follow"). - Default: "follow" + (default: follow) ``profiling`` @@ -1170,7 +1168,7 @@ ``type`` The type of profiler to use. - Default: ls. + (default: ls) ``ls`` Use Python's built-in instrumenting profiler. This profiler @@ -1184,7 +1182,7 @@ ``format`` Profiling format. Specific to the ``ls`` instrumenting profiler. - Default: text. + (default: text) ``text`` Generate a profiling report. When saving to a file, it should be @@ -1197,28 +1195,28 @@ ``frequency`` Sampling frequency. Specific to the ``stat`` sampling profiler. - Default: 1000. + (default: 1000) ``output`` File path where profiling data or report should be saved. If the - file exists, it is replaced. Default: None, data is printed on - stderr + file exists, it is replaced. (default: None, data is printed on + stderr) ``sort`` Sort field. Specific to the ``ls`` instrumenting profiler. One of ``callcount``, ``reccallcount``, ``totaltime`` and ``inlinetime``. - Default: inlinetime. + (default: inlinetime) ``limit`` Number of lines to show. Specific to the ``ls`` instrumenting profiler. - Default: 30. + (default: 30) ``nested`` Show at most this number of lines of drill-down info after each main entry. This can help explain the difference between Total and Inline. Specific to the ``ls`` instrumenting profiler. - Default: 5. + (default: 5) ``progress`` ------------ @@ -1253,7 +1251,7 @@ term width) will be used). ``clear-complete`` - clear the progress bar after it's done (default to True) + clear the progress bar after it's done. (default: True) ``disable`` If true, don't show a progress bar. @@ -1281,20 +1279,20 @@ about 6 Mbps), uncompressed streaming is slower, because of the extra data transfer overhead. This mode will also temporarily hold the write lock while determining what data to transfer. - Default is True. + (default: True) ``preferuncompressed`` When set, clients will try to use the uncompressed streaming - protocol. Default is False. + protocol. (default: False) ``validate`` Whether to validate the completeness of pushed changesets by checking that all new file revisions specified in manifests are - present. Default is False. + present. (default: False) ``maxhttpheaderlen`` Instruct HTTP clients not to send request headers longer than this - many bytes. Default is 1024. + many bytes. (default: 1024) ``smtp`` -------- @@ -1305,12 +1303,12 @@ Host name of mail server, e.g. "mail.example.com". ``port`` - Optional. Port to connect to on mail server. Default: 465 (if - ``tls`` is smtps) or 25 (otherwise). + Optional. Port to connect to on mail server. (default: 465 if + ``tls`` is smtps; 25 otherwise) ``tls`` Optional. Method to enable TLS when connecting to mail server: starttls, - smtps or none. Default: none. + smtps or none. (default: none) ``verifycert`` Optional. Verification for the certificate of mail server, when @@ -1320,16 +1318,16 @@ ``[web] cacerts`` also). For "strict", sending email is also aborted, if there is no configuration for mail server in ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for - :hg:`email` overwrites this as "loose". Default: "strict". + :hg:`email` overwrites this as "loose". (default: strict) ``username`` Optional. User name for authenticating with the SMTP server. - Default: none. + (default: None) ``password`` Optional. Password for authenticating with the SMTP server. If not specified, interactive sessions will prompt the user for a - password; non-interactive sessions will fail. Default: none. + password; non-interactive sessions will fail. (default: None) ``local_hostname`` Optional. The hostname that the sender can use to identify @@ -1391,30 +1389,30 @@ Whether to include the .hg_archival.txt file containing meta data (hashes for the repository base and for tip) in archives created by the :hg:`archive` command or downloaded via hgweb. - Default is True. + (default: True) ``askusername`` Whether to prompt for a username when committing. If True, and neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will be prompted to enter a username. If no username is entered, the default ``USER@HOST`` is used instead. - Default is False. + (default: False) ``commitsubrepos`` Whether to commit modified subrepositories when committing the parent repository. If False and one subrepository has uncommitted changes, abort the commit. - Default is False. + (default: False) ``debug`` - Print debugging information. True or False. Default is False. + Print debugging information. True or False. (default: False) ``editor`` - The editor to use during a commit. Default is ``$EDITOR`` or ``vi``. + The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) ``fallbackencoding`` Encoding to try if it's not possible to decode the changelog using - UTF-8. Default is ISO-8859-1. + UTF-8. (default: ISO-8859-1) ``ignore`` A file to read per-user ignore patterns from. This file should be @@ -1425,7 +1423,7 @@ of the ignore file format, see the ``hgignore(5)`` man page. ``interactive`` - Allow to prompt the user. True or False. Default is True. + Allow to prompt the user. True or False. (default: True) ``logtemplate`` Template string for commands that print changesets. @@ -1440,7 +1438,7 @@ style uses the ``mergemarkertemplate`` setting to style the labels. The ``basic`` style just uses 'local' and 'other' as the marker label. One of ``basic`` or ``detailed``. - Default is ``basic``. + (default: ``basic``) ``mergemarkertemplate`` The template used to print the commit description next to each conflict @@ -1473,7 +1471,7 @@ ``portablefilenames`` Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. - Default is ``warn``. + (default: ``warn``) If set to ``warn`` (or ``true``), a warning message is printed on POSIX platforms, if a file with a non-portable filename is added (e.g. a file with a name that can't be created on Windows because it contains reserved @@ -1484,56 +1482,58 @@ On Windows, this configuration option is ignored and the command aborted. ``quiet`` - Reduce the amount of output printed. True or False. Default is False. + Reduce the amount of output printed. True or False. (default: False) ``remotecmd`` - remote command to use for clone/push/pull operations. Default is ``hg``. + remote command to use for clone/push/pull operations. (default: ``hg``) ``report_untrusted`` Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a - trusted user or group. True or False. Default is True. + trusted user or group. True or False. (default: True) ``slash`` Display paths using a slash (``/``) as the path separator. This only makes a difference on systems where the default path separator is not the slash character (e.g. Windows uses the backslash character (``\``)). - Default is False. + (default: False) ``statuscopies`` Display copies in the status command. ``ssh`` - command to use for SSH connections. Default is ``ssh``. + command to use for SSH connections. (default: ``ssh``) ``strict`` Require exact command names, instead of allowing unambiguous - abbreviations. True or False. Default is False. + abbreviations. True or False. (default: False) ``style`` Name of style to use for command output. ``timeout`` The timeout used when a lock is held (in seconds), a negative value - means no timeout. Default is 600. + means no timeout. (default: 600) ``traceback`` Mercurial always prints a traceback when an unknown exception occurs. Setting this to True will make Mercurial print a traceback on all exceptions, even those recognized by Mercurial (such as - IOError or MemoryError). Default is False. + IOError or MemoryError). (default: False) ``username`` The committer of a changeset created when running "commit". Typically a person's name and email address, e.g. ``Fred Widget - <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If - the username in hgrc is empty, it has to be specified manually or - in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set - ``username =`` in the system hgrc). Environment variables in the + <fred@example.com>``. Environment variables in the username are expanded. + (default: ``$EMAIL`` or ``username@hostname``. If the username in + hgrc is empty, e.g. if the system admin set ``username =`` in the + system hgrc, it has to be specified manually or in a different + hgrc file) + ``verbose`` - Increase the amount of output printed. True or False. Default is False. + Increase the amount of output printed. True or False. (default: False) ``web`` @@ -1563,27 +1563,27 @@ The full set of options is: ``accesslog`` - Where to output the access log. Default is stdout. + Where to output the access log. (default: stdout) ``address`` - Interface address to bind to. Default is all. + Interface address to bind to. (default: all) ``allow_archive`` List of archive format (bz2, gz, zip) allowed for downloading. - Default is empty. + (default: empty) ``allowbz2`` (DEPRECATED) Whether to allow .tar.bz2 downloading of repository revisions. - Default is False. + (default: False) ``allowgz`` (DEPRECATED) Whether to allow .tar.gz downloading of repository revisions. - Default is False. + (default: False) ``allowpull`` - Whether to allow pulling from the repository. Default is True. + Whether to allow pulling from the repository. (default: True) ``allow_push`` Whether to allow pushing to the repository. If empty or not set, @@ -1606,11 +1606,12 @@ ``allowzip`` (DEPRECATED) Whether to allow .zip downloading of repository - revisions. Default is False. This feature creates temporary files. + revisions. This feature creates temporary files. + (default: False) ``archivesubrepos`` - Whether to recurse into subrepositories when archiving. Default is - False. + Whether to recurse into subrepositories when archiving. + (default: False) ``baseurl`` Base URL to use when publishing URLs in other locations, so @@ -1645,7 +1646,7 @@ -----END CERTIFICATE----- ``cache`` - Whether to support caching in hgweb. Defaults to True. + Whether to support caching in hgweb. (default: True) ``certificate`` Certificate to use when running :hg:`serve`. @@ -1657,17 +1658,18 @@ the current path are grouped behind navigable directory entries that lead to the locations of these repositories. In effect, this setting collapses each collection of repositories found within a subdirectory - into a single entry for that subdirectory. Default is False. + into a single entry for that subdirectory. (default: False) ``comparisoncontext`` Number of lines of context to show in side-by-side file comparison. If - negative or the value ``full``, whole files are shown. Default is 5. + negative or the value ``full``, whole files are shown. (default: 5) + This setting can be overridden by a ``context`` request parameter to the ``comparison`` command, taking the same values. ``contact`` Name or email address of the person in charge of the repository. - Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty. + (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty) ``deny_push`` Whether to deny pushing to the repository. If empty or not set, @@ -1698,28 +1700,28 @@ ``description`` Textual description of the repository's purpose or contents. - Default is "unknown". + (default: "unknown") ``encoding`` - Character encoding name. Default is the current locale charset. + Character encoding name. (default: the current locale charset) Example: "UTF-8". ``errorlog`` - Where to output the error log. Default is stderr. + Where to output the error log. (default: stderr) ``guessmime`` Control MIME types for raw download of file content. Set to True to let hgweb guess the content type from the file extension. This will serve HTML files as ``text/html`` and might allow cross-site scripting attacks when serving untrusted - repositories. Default is False. + repositories. (default: False) ``hidden`` Whether to hide the repository in the hgwebdir index. - Default is False. + (default: False) ``ipv6`` - Whether to use IPv6. Default is False. + Whether to use IPv6. (default: False) ``logoimg`` File name of the logo image that some templates display on each page. @@ -1732,28 +1734,28 @@ will be used. ``maxchanges`` - Maximum number of changes to list on the changelog. Default is 10. + Maximum number of changes to list on the changelog. (default: 10) ``maxfiles`` - Maximum number of files to list per changeset. Default is 10. + Maximum number of files to list per changeset. (default: 10) ``maxshortchanges`` Maximum number of changes to list on the shortlog, graph or filelog - pages. Default is 60. + pages. (default: 60) ``name`` - Repository name to use in the web interface. Default is current - working directory. + Repository name to use in the web interface. + (default: current working directory) ``port`` - Port to listen on. Default is 8000. + Port to listen on. (default: 8000) ``prefix`` - Prefix path to serve from. Default is '' (server root). + Prefix path to serve from. (default: '' (server root)) ``push_ssl`` Whether to require that inbound pushes be transported over SSL to - prevent password sniffing. Default is True. + prevent password sniffing. (default: True) ``refreshinterval`` How frequently directory listings re-scan the filesystem for new @@ -1761,7 +1763,8 @@ to define paths. Depending on how much filesystem traversal is required, refreshing may negatively impact performance. - Default is 20. Values less than or equal to 0 always refresh. + Values less than or equal to 0 always refresh. + (default: 20) ``staticurl`` Base URL to use for static files. If unset, static files (e.g. the @@ -1771,12 +1774,12 @@ ``stripes`` How many lines a "zebra stripe" should span in multi-line output. - Default is 1; set to 0 to disable. + Set to 0 to disable. (default: 1) ``style`` Which template map style to use. The available options are the names of - subdirectories in the HTML templates path. Default is ``paper``. - Example: ``monoblue`` + subdirectories in the HTML templates path. (default: ``paper``) + Example: ``monoblue``. ``templates`` Where to find the HTML templates. The default path to the HTML templates @@ -1823,6 +1826,6 @@ helps performance. ``numcpus`` - Number of CPUs to use for parallel operations. Default is 4 or the - number of CPUs on the system, whichever is larger. A zero or + Number of CPUs to use for parallel operations. A zero or negative value is treated as ``use the default``. + (default: 4 or the number of CPUs on the system, whichever is larger)
--- a/tests/test-help.t Wed Sep 02 02:05:32 2015 -0400 +++ b/tests/test-help.t Wed Sep 02 13:39:46 2015 -0400 @@ -1130,8 +1130,7 @@ "default" Directory or URL to use when pulling if no source is specified. - Default is set to repository from which the current repository was - cloned. + (default: repository from which the current repository was cloned) "default-push" Optional. Directory or URL to use when pushing if no destination is