{ "mode": "man", "parameter": "hgrc", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/hgrc/5/json", "generated": "2026-10-08T07:46:01Z", "sections": { "NAME": { "content": "hgrc - configuration files for Mercurial\n", "subsections": [] }, "DESCRIPTION": { "content": "The Mercurial system uses a set of configuration files to control aspects of its behavior.\n", "subsections": [] }, "TROUBLESHOOTING": { "content": "If you're having problems with your configuration, hg config --source can help you understand\nwhat is introducing a setting into your environment.\n\nSee hg help config.syntax and hg help config.files for information about how and where to\noverride things.\n", "subsections": [] }, "STRUCTURE": { "content": "The configuration files use a simple ini-file format. A configuration file consists of sec‐\ntions, led by a [section] header and followed by name = value entries:\n\n[ui]\nusername = Firstname Lastname \nverbose = True\n\nThe above entries will be referred to as ui.username and ui.verbose, respectively. See hg\nhelp config.syntax.\n", "subsections": [] }, "FILES": { "content": "Mercurial reads configuration data from several files, if they exist. These files do not ex‐\nist by default and you will have to create the appropriate configuration files yourself:\n\nLocal configuration is put into the per-repository /.hg/hgrc file.\n\nGlobal configuration like the username setting is typically put into:\n\n• %USERPROFILE%\\mercurial.ini (on Windows)\n\n• $HOME/.hgrc (on Unix, Plan9)\n\nThe names of these files depend on the system on which Mercurial is installed. *.rc files\nfrom a single directory are read in alphabetical order, later ones overriding earlier ones.\nWhere multiple paths are given below, settings from earlier paths override later ones.\n\nOn Unix, the following files are consulted:\n\n• /.hg/hgrc-not-shared (per-repository)\n\n• /.hg/hgrc (per-repository)\n\n• $HOME/.hgrc (per-user)\n\n• ${XDGCONFIGHOME:-$HOME/.config}/hg/hgrc (per-user)\n\n• /etc/mercurial/hgrc (per-installation)\n\n• /etc/mercurial/hgrc.d/*.rc (per-installation)\n\n• /etc/mercurial/hgrc (per-system)\n\n• /etc/mercurial/hgrc.d/*.rc (per-system)\n\n• /*.rc (defaults)\n\nOn Windows, the following files are consulted:\n\n• /.hg/hgrc-not-shared (per-repository)\n\n• /.hg/hgrc (per-repository)\n\n• %USERPROFILE%\\.hgrc (per-user)\n\n• %USERPROFILE%\\Mercurial.ini (per-user)\n\n• %HOME%\\.hgrc (per-user)\n\n• %HOME%\\Mercurial.ini (per-user)\n\n• HKEYLOCALMACHINE\\SOFTWARE\\Mercurial (per-system)\n\n• \\hgrc.d\\*.rc (per-installation)\n\n• \\Mercurial.ini (per-installation)\n\n• %PROGRAMDATA%\\Mercurial\\hgrc (per-system)\n\n• %PROGRAMDATA%\\Mercurial\\Mercurial.ini (per-system)\n\n• %PROGRAMDATA%\\Mercurial\\hgrc.d\\*.rc (per-system)\n\n• /*.rc (defaults)\n\nNote The registry key HKEYLOCALMACHINE\\SOFTWARE\\Wow6432Node\\Mercurial is used when run‐\nning 32-bit Python on 64-bit Windows.\n\nOn Plan9, the following files are consulted:\n\n• /.hg/hgrc-not-shared (per-repository)\n\n• /.hg/hgrc (per-repository)\n\n• $home/lib/hgrc (per-user)\n\n• /lib/mercurial/hgrc (per-installation)\n\n• /lib/mercurial/hgrc.d/*.rc (per-installation)\n\n• /lib/mercurial/hgrc (per-system)\n\n• /lib/mercurial/hgrc.d/*.rc (per-system)\n\n• /*.rc (defaults)\n\nPer-repository configuration options only apply in a particular repository. This file is not\nversion-controlled, and will not get transferred during a \"clone\" operation. Options in this\nfile override options in all other configuration files.\n\nOn Plan 9 and Unix, most of this file will be ignored if it doesn't belong to a trusted user\nor to a trusted group. See hg help config.trusted for more details.\n\nPer-user configuration file(s) are for the user running Mercurial. Options in these files\napply to all Mercurial commands executed by this user in any directory. Options in these\nfiles override per-system and per-installation options.\n\nPer-installation configuration files are searched for in the directory where Mercurial is in‐\nstalled. is the parent directory of the hg executable (or symlink) being run.\n\nFor example, if installed in /shared/tools/bin/hg, Mercurial will look in\n/shared/tools/etc/mercurial/hgrc. Options in these files apply to all Mercurial commands exe‐\ncuted by any user in any directory.\n\nPer-installation configuration files are for the system on which Mercurial is running. Op‐\ntions in these files apply to all Mercurial commands executed by any user in any directory.\nRegistry keys contain PATH-like strings, every part of which must reference a Mercurial.ini\nfile or be a directory where *.rc files will be read. Mercurial checks each of these loca‐\ntions in the specified order until one or more configuration files are detected.\n\nPer-system configuration files are for the system on which Mercurial is running. Options in\nthese files apply to all Mercurial commands executed by any user in any directory. Options in\nthese files override per-installation options.\n\nMercurial comes with some default configuration. The default configuration files are in‐\nstalled with Mercurial and will be overwritten on upgrades. Default configuration files\nshould never be edited by users or administrators but can be overridden in other configura‐\ntion files. So far the directory only contains merge tool configuration but packagers can\nalso put other default configuration there.\n\nOn versions 5.7 and later, if share-safe functionality is enabled, shares will read config\nfile of share source too. is read before reading .\n\nFor configs which should not be shared, should be used.\n", "subsections": [] }, "SYNTAX": { "content": "A configuration file consists of sections, led by a [section] header and followed by name =\nvalue entries (sometimes called configuration keys):\n\n[spam]\neggs=ham\ngreen=\neggs\n\nEach line contains one entry. If the lines that follow are indented, they are treated as con‐\ntinuations of that entry. Leading whitespace is removed from values. Empty lines are skipped.\nLines beginning with # or ; are ignored and may be used to provide comments.\n\nConfiguration keys can be set multiple times, in which case Mercurial will use the value that\nwas configured last. As an example:\n\n[spam]\neggs=large\nham=serrano\neggs=small\n\nThis would set the configuration key named eggs to small.\n\nIt is also possible to define a section multiple times. A section can be redefined on the\nsame and/or on different configuration files. For example:\n\n[foo]\neggs=large\nham=serrano\neggs=small\n\n[bar]\neggs=ham\ngreen=\neggs\n\n[foo]\nham=prosciutto\neggs=medium\nbread=toasted\n\nThis would set the eggs, ham, and bread configuration keys of the foo section to medium, pro‐\nsciutto, and toasted, respectively. As you can see there only thing that matters is the last\nvalue that was set for each of the configuration keys.\n\nIf a configuration key is set multiple times in different configuration files the final value\nwill depend on the order in which the different configuration files are read, with settings\nfrom earlier paths overriding later ones as described on the Files section above.\n\nA line of the form %include file will include file into the current configuration file. The\ninclusion is recursive, which means that included files can include other files. Filenames\nare relative to the configuration file in which the %include directive is found. Environment\nvariables and ~user constructs are expanded in file. This lets you do something like:\n\n%include ~/.hgrc.d/$HOST.rc\n\nto include a different configuration file on each computer you use.\n\nA line with %unset name will remove name from the current section, if it has been set previ‐\nously.\n\nThe values are either free-form text strings, lists of text strings, or Boolean values.\nBoolean values can be set to true using any of \"1\", \"yes\", \"true\", or \"on\" and to false using\n\"0\", \"no\", \"false\", or \"off\" (all case insensitive).\n\nList values are separated by whitespace or comma, except when values are placed in double\nquotation marks:\n\nallowread = \"John Doe, PhD\", brian, betty\n\nQuotation marks can be escaped by prefixing them with a backslash. Only quotation marks at\nthe beginning of a word is counted as a quotation (e.g., foo\"bar baz is the list of foo\"bar\nand baz).\n", "subsections": [] }, "SECTIONS": { "content": "This section describes the different sections that may appear in a Mercurial configuration\nfile, the purpose of each section, its possible keys, and their possible values.\n", "subsections": [ { "name": "alias", "content": "Defines command aliases.\n\nAliases allow you to define your own commands in terms of other commands (or aliases), op‐\ntionally including arguments. Positional arguments in the form of $1, $2, etc. in the alias\ndefinition are expanded by Mercurial before execution. Positional arguments not already used\nby $N in the definition are put at the end of the command to be executed.\n\nAlias definitions consist of lines of the form:\n\n = []...\n\nFor example, this definition:\n\nlatest = log --limit 5\n\ncreates a new command latest that shows only the five most recent changesets. You can define\nsubsequent aliases using earlier ones:\n\nstable5 = latest -b stable\n\nNote It is possible to create aliases with the same names as existing commands, which will\nthen override the original definitions. This is almost always a bad idea!\n\nAn alias can start with an exclamation point (!) to make it a shell alias. A shell alias is\nexecuted with the shell and will let you run arbitrary commands. As an example,\n\necho = !echo $@\n\nwill let you do hg echo foo to have foo printed in your terminal. A better example might be:\n\npurge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f\n\nwhich will make hg purge delete all unknown files in the repository in the same manner as the\npurge extension.\n\nPositional arguments like $1, $2, etc. in the alias definition expand to the command argu‐\nments. Unmatched arguments are removed. $0 expands to the alias name and $@ expands to all\narguments separated by a space. \"$@\" (with quotes) expands to all arguments quoted individu‐\nally and separated by a space. These expansions happen before the command is passed to the\nshell.\n\nShell aliases are executed in an environment where $HG expands to the path of the Mercurial\nthat was used to execute the alias. This is useful when you want to call further Mercurial\ncommands in a shell alias, as was done above for the purge alias. In addition, $HGARGS ex‐\npands to the arguments given to Mercurial. In the hg echo foo call above, $HGARGS would ex‐\npand to echo foo.\n\nNote Some global configuration options such as -R are processed before shell aliases and\nwill thus not be passed to aliases.\n" }, { "name": "annotate", "content": "Settings used when displaying file annotations. All values are Booleans and default to False.\nSee hg help config.diff for related options for the diff command.\n" }, { "name": "ignorews", "content": "Ignore white space when comparing lines.\n" }, { "name": "ignorewseol", "content": "Ignore white space at the end of a line when comparing lines.\n" }, { "name": "ignorewsamount", "content": "Ignore changes in the amount of white space.\n" }, { "name": "ignoreblanklines", "content": "Ignore changes whose lines are all blank.\n" }, { "name": "auth", "content": "Authentication credentials and other authentication-like configuration for HTTP connections.\nThis section allows you to store usernames and passwords for use when logging into HTTP\nservers. See hg help config.web if you want to configure who can login to your HTTP server.\n\nThe following options apply to all hosts.\n" }, { "name": "cookiefile", "content": "Path to a file containing HTTP cookie lines. Cookies matching a host will be sent au‐\ntomatically.\n\nThe file format uses the Mozilla cookies.txt format, which defines cookies on their\nown lines. Each line contains 7 fields delimited by the tab character (domain, isdo‐\nmaincookie, path, issecure, expires, name, value). For more info, do an Internet\nsearch for \"Netscape cookies.txt format.\"\n\nNote: the cookies parser does not handle port numbers on domains. You will need to re‐\nmove ports from the domain for the cookie to be recognized. This could result in a\ncookie being disclosed to an unwanted server.\n\nThe cookies file is read-only.\n\nOther options in this section are grouped by name and have the following format:\n\n. = \n\nwhere is used to group arguments into authentication entries. Example:\n\nfoo.prefix = hg.intevation.de/mercurial\nfoo.username = foo\nfoo.password = bar\nfoo.schemes = http https\n\nbar.prefix = secure.example.org\nbar.key = path/to/file.key\nbar.cert = path/to/file.cert\nbar.schemes = https\n\nSupported arguments:\n" }, { "name": "prefix", "content": "Either * or a URI prefix with or without the scheme part. The authentication entry\nwith the longest matching prefix is used (where * matches everything and counts as a\nmatch of length 1). If the prefix doesn't include a scheme, the match is performed\nagainst the URI with its scheme stripped as well, and the schemes argument, q.v., is\nthen subsequently consulted.\n" }, { "name": "username", "content": "Optional. Username to authenticate with. If not given, and the remote site requires\nbasic or digest authentication, the user will be prompted for it. Environment vari‐\nables are expanded in the username letting you do foo.username = $USER. If the URI in‐\ncludes a username, only [auth] entries with a matching username or without a username\nwill be considered.\n" }, { "name": "password", "content": "Optional. Password to authenticate with. If not given, and the remote site requires\nbasic or digest authentication, the user will be prompted for it.\n" }, { "name": "key", "content": "Optional. PEM encoded client certificate key file. Environment variables are expanded\nin the filename.\n" }, { "name": "cert", "content": "Optional. PEM encoded client certificate chain file. Environment variables are ex‐\npanded in the filename.\n" }, { "name": "schemes", "content": "Optional. Space separated list of URI schemes to use this authentication entry with.\nOnly used if the prefix doesn't include a scheme. Supported schemes are http and\nhttps. They will match static-http and static-https respectively, as well. (default:\nhttps)\n\nIf no suitable authentication entry is found, the user is prompted for credentials as usual\nif required by the remote.\n" }, { "name": "cmdserver", "content": "Controls command server settings. (ADVANCED)\n" }, { "name": "message-encodings", "content": "List of encodings for the m (message) channel. The first encoding supported by the\nserver will be selected and advertised in the hello message. This is useful only when\nui.message-output is set to channel. Supported encodings are cbor.\n" }, { "name": "shutdown-on-interrupt", "content": "If set to false, the server's main loop will continue running after SIGINT received.\nruncommand requests can still be interrupted by SIGINT. Close the write end of the\npipe to shut down the server process gracefully. (default: True)\n" }, { "name": "color", "content": "Configure the Mercurial color mode. For details about how to define your custom effect and\nstyle see hg help color.\n" }, { "name": "mode", "content": "String: control the method used to output color. One of auto, ansi, win32, terminfo or\ndebug. In auto mode, Mercurial will use ANSI mode by default (or win32 mode prior to\nWindows 10) if it detects a terminal. Any invalid value will disable color.\n" }, { "name": "pagermode", "content": "String: optional override of color.mode used with pager.\n\nOn some systems, terminfo mode may cause problems when using color with less -R as a\npager program. less with the -R option will only display ECMA-48 color codes, and ter‐\nminfo mode may sometimes emit codes that less doesn't understand. You can work around\nthis by either using ansi mode (or auto mode), or by using less -r (which will pass\nthrough all terminal control codes, not just color control codes).\n\nOn some systems (such as MSYS in Windows), the terminal may support a different color\nmode than the pager program.\n" }, { "name": "commands", "content": "" }, { "name": "commit.post-status", "content": "Show status of files in the working directory after successful commit. (default:\nFalse)\n" }, { "name": "merge.require-rev", "content": "Require that the revision to merge the current commit with be specified on the command\nline. If this is enabled and a revision is not specified, the command aborts. (de‐\nfault: False)\n" }, { "name": "push.require-revs", "content": "Require revisions to push be specified using one or more mechanisms such as specifying\nthem positionally on the command line, using -r, -b, and/or -B on the command line, or\nusing paths.:pushrev in the configuration. If this is enabled and revisions are\nnot specified, the command aborts. (default: False)\n" }, { "name": "resolve.confirm", "content": "Confirm before performing action if no filename is passed. (default: False)\n" }, { "name": "resolve.explicit-re-merge", "content": "Require uses of hg resolve to specify which action it should perform, instead of\nre-merging files by default. (default: False)\n" }, { "name": "resolve.mark-check", "content": "Determines what level of checking hg resolve --mark will perform before marking files\nas resolved. Valid values are none`, ``warn, and abort. warn will output a warning\nlisting the file(s) that still have conflict markers in them, but will still mark\neverything resolved. abort will output the same warning but will not mark things as\nresolved. If --all is passed and this is set to abort, only a warning will be shown\n(an error will not be raised). (default: none)\n" }, { "name": "status.relative", "content": "Make paths in hg status output relative to the current directory. (default: False)\n" }, { "name": "status.terse", "content": "Default value for the --terse flag, which condenses status output. (default: empty)\n" }, { "name": "update.check", "content": "Determines what level of checking hg update will perform before moving to a destina‐\ntion revision. Valid values are abort, none, linear, and noconflict.\n\n• abort always fails if the working directory has uncommitted changes.\n\n• none performs no checking, and may result in a merge with uncommitted changes.\n\n• linear allows any update as long as it follows a straight line in the revision his‐\ntory, and may trigger a merge with uncommitted changes.\n\n• noconflict will allow any update which would not trigger a merge with uncommitted\nchanges, if any are present.\n\n(default: linear)\n" }, { "name": "update.requiredest", "content": "Require that the user pass a destination when running hg update. For example, hg up‐\ndate .:: will be allowed, but a plain hg update will be disallowed. (default: False)\n" }, { "name": "committemplate", "content": "" }, { "name": "changeset", "content": "String: configuration in this section is used as the template to customize the text\nshown in the editor when committing.\n\nIn addition to pre-defined template keywords, commit log specific one below can be used for\ncustomization:\n" }, { "name": "extramsg", "content": "String: Extra message (typically 'Leave message empty to abort commit.'). This may be\nchanged by some commands or extensions.\n\nFor example, the template configuration below shows as same text as one shown by default:\n\n[committemplate]\nchangeset = {desc}\\n\\n\nHG: Enter commit message. Lines beginning with 'HG:' are removed.\nHG: {extramsg}\nHG: --\nHG: user: {author}\\n{ifeq(p2rev, \"-1\", \"\",\n\"HG: branch merge\\n\")\n}HG: branch '{branch}'\\n{if(activebookmark,\n\"HG: bookmark '{activebookmark}'\\n\") }{subrepos %\n\"HG: subrepo {subrepo}\\n\" }{fileadds %\n\"HG: added {file}\\n\" }{filemods %\n\"HG: changed {file}\\n\" }{filedels %\n\"HG: removed {file}\\n\" }{if(files, \"\",\n\"HG: no files changed\\n\")}\n" }, { "name": "diff()", "content": "String: show the diff (see hg help templates for detail)\n\nSometimes it is helpful to show the diff of the changeset in the editor without having to\nprefix 'HG: ' to each line so that highlighting works correctly. For this, Mercurial provides\na special string which will ignore everything below it:\n\nHG: ------------------------ >8 ------------------------\n\nFor example, the template configuration below will show the diff below the extra message:\n\n[committemplate]\nchangeset = {desc}\\n\\n\nHG: Enter commit message. Lines beginning with 'HG:' are removed.\nHG: {extramsg}\nHG: ------------------------ >8 ------------------------\nHG: Do not touch the line above.\nHG: Everything below will be removed.\n{diff()}\n\nNote For some problematic encodings (see hg help win32mbcs for detail), this customization\nshould be configured carefully, to avoid showing broken characters.\n\nFor example, if a multibyte character ending with backslash (0x5c) is followed by the\nASCII character 'n' in the customized template, the sequence of backslash and 'n' is\ntreated as line-feed unexpectedly (and the multibyte character is broken, too).\n\nCustomized template is used for commands below (--edit may be required):\n\n• hg backout\n\n• hg commit\n\n• hg fetch (for merge commit only)\n\n• hg graft\n\n• hg histedit\n\n• hg import\n\n• hg qfold, hg qnew and hg qrefresh\n\n• hg rebase\n\n• hg shelve\n\n• hg sign\n\n• hg tag\n\n• hg transplant\n\nConfiguring items below instead of changeset allows showing customized message only for spe‐\ncific actions, or showing different messages for each action.\n\n• changeset.backout for hg backout\n\n• changeset.commit.amend.merge for hg commit --amend on merges\n\n• changeset.commit.amend.normal for hg commit --amend on other\n\n• changeset.commit.normal.merge for hg commit on merges\n\n• changeset.commit.normal.normal for hg commit on other\n\n• changeset.fetch for hg fetch (impling merge commit)\n\n• changeset.gpg.sign for hg sign\n\n• changeset.graft for hg graft\n\n• changeset.histedit.edit for edit of hg histedit\n\n• changeset.histedit.fold for fold of hg histedit\n\n• changeset.histedit.mess for mess of hg histedit\n\n• changeset.histedit.pick for pick of hg histedit\n\n• changeset.import.bypass for hg import --bypass\n\n• changeset.import.normal.merge for hg import on merges\n\n• changeset.import.normal.normal for hg import on other\n\n• changeset.mq.qnew for hg qnew\n\n• changeset.mq.qfold for hg qfold\n\n• changeset.mq.qrefresh for hg qrefresh\n\n• changeset.rebase.collapse for hg rebase --collapse\n\n• changeset.rebase.merge for hg rebase on merges\n\n• changeset.rebase.normal for hg rebase on other\n\n• changeset.shelve.shelve for hg shelve\n\n• changeset.tag.add for hg tag without --remove\n\n• changeset.tag.remove for hg tag --remove\n\n• changeset.transplant.merge for hg transplant on merges\n\n• changeset.transplant.normal for hg transplant on other\n\nThese dot-separated lists of names are treated as hierarchical ones. For example, change‐\nset.tag.remove customizes the commit message only for hg tag --remove, but changeset.tag cus‐\ntomizes the commit message for hg tag regardless of --remove option.\n\nWhen the external editor is invoked for a commit, the corresponding dot-separated list of\nnames without the changeset. prefix (e.g. commit.normal.normal) is in the HGEDITFORM environ‐\nment variable.\n\nIn this section, items other than changeset can be referred from others. For example, the\nconfiguration to list committed files up below can be referred as {listupfiles}:\n\n[committemplate]\nlistupfiles = {fileadds %\n\"HG: added {file}\\n\" }{filemods %\n\"HG: changed {file}\\n\" }{filedels %\n\"HG: removed {file}\\n\" }{if(files, \"\",\n\"HG: no files changed\\n\")}\n" }, { "name": "decode/encode", "content": "Filters for transforming files on checkout/checkin. This would typically be used for newline\nprocessing or other localization/canonicalization of files.\n\nFilters consist of a filter pattern followed by a filter command. Filter patterns are globs\nby default, rooted at the repository root. For example, to match any file ending in .txt in\nthe root directory only, use the pattern *.txt. To match any file ending in .c anywhere in\nthe repository, use the pattern .c. For each file only the first matching filter applies.\n\nThe filter command can start with a specifier, either pipe: or tempfile:. If no specifier is\ngiven, pipe: is used by default.\n\nA pipe: command must accept data on stdin and return the transformed data on stdout.\n\nPipe example:\n\n[encode]\n# uncompress gzip files on checkin to improve delta compression\n# note: not necessarily a good idea, just an example\n*.gz = pipe: gunzip\n\n[decode]\n# recompress gzip files when writing them to the working dir (we\n# can safely omit \"pipe:\", because it's the default)\n*.gz = gzip\n\nA tempfile: command is a template. The string INFILE is replaced with the name of a temporary\nfile that contains the data to be filtered by the command. The string OUTFILE is replaced\nwith the name of an empty temporary file, where the filtered data must be written by the com‐\nmand.\n\nNote The tempfile mechanism is recommended for Windows systems, where the standard shell\nI/O redirection operators often have strange effects and may corrupt the contents of\nyour files.\n\nThis filter mechanism is used internally by the eol extension to translate line ending char‐\nacters between Windows (CRLF) and Unix (LF) format. We suggest you use the eol extension for\nconvenience.\n" }, { "name": "defaults", "content": "(defaults are deprecated. Don't use them. Use aliases instead.)\n\nUse the [defaults] section to define command defaults, i.e. the default options/arguments to\npass to the specified commands.\n\nThe following example makes hg log run in verbose mode, and hg status show only the modified\nfiles, by default:\n\n[defaults]\nlog = -v\nstatus = -m\n\nThe actual commands, instead of their aliases, must be used when defining command defaults.\nThe command defaults will also be applied to the aliases of the commands defined.\n" }, { "name": "diff", "content": "Settings used when displaying diffs. Everything except for unified is a Boolean and defaults\nto False. See hg help config.annotate for related options for the annotate command.\n" }, { "name": "git", "content": "Use git extended diff format.\n" }, { "name": "nobinary", "content": "Omit git binary patches.\n" }, { "name": "nodates", "content": "Don't include dates in diff headers.\n" }, { "name": "noprefix", "content": "Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.\n" }, { "name": "showfunc", "content": "Show which function each change is in.\n" }, { "name": "ignorews", "content": "Ignore white space when comparing lines.\n" }, { "name": "ignorewsamount", "content": "Ignore changes in the amount of white space.\n" }, { "name": "ignoreblanklines", "content": "Ignore changes whose lines are all blank.\n" }, { "name": "unified", "content": "Number of lines of context to show.\n" }, { "name": "word-diff", "content": "Highlight changed words.\n" }, { "name": "email", "content": "Settings for extensions that send email messages.\n" }, { "name": "from", "content": "Optional. Email address to use in \"From\" header and SMTP envelope of outgoing mes‐\nsages.\n\nto\n\nOptional. Comma-separated list of recipients' email addresses.\n\ncc\n\nOptional. Comma-separated list of carbon copy recipients' email addresses.\n" }, { "name": "bcc", "content": "Optional. Comma-separated list of blind carbon copy recipients' email addresses.\n" }, { "name": "method", "content": "Optional. Method to use to send email messages. If value is smtp (default), use SMTP\n(see the [smtp] section for configuration). Otherwise, use as name of program to run\nthat acts like sendmail (takes -f option for sender, list of recipients on command\nline, message on stdin). Normally, setting this to sendmail or /usr/sbin/sendmail is\nenough to use sendmail to send messages.\n" }, { "name": "charsets", "content": "Optional. Comma-separated list of character sets considered convenient for recipients.\nAddresses, headers, and parts not containing patches of outgoing messages will be en‐\ncoded in the first character set to which conversion from local encoding ($HGENCODING,\nui.fallbackencoding) succeeds. If correct conversion fails, the text in question is\nsent as is. (default: '')\n\nOrder of outgoing email character sets:\n\n1. us-ascii: always first, regardless of settings\n\n2. email.charsets: in order given by user\n\n3. ui.fallbackencoding: if not in email.charsets\n\n4. $HGENCODING: if not in email.charsets\n\n5. utf-8: always last, regardless of settings\n\nEmail example:\n\n[email]\nfrom = Joseph User \nmethod = /usr/sbin/sendmail\n# charsets for western Europeans\n# us-ascii, utf-8 omitted, as they are tried first and last\ncharsets = iso-8859-1, iso-8859-15, windows-1252\n" }, { "name": "extensions", "content": "Mercurial has an extension mechanism for adding new features. To enable an extension, create\nan entry for it in this section.\n\nIf you know that the extension is already in Python's search path, you can give the name of\nthe module, followed by =, with nothing after the =.\n\nOtherwise, give a name that you choose, followed by =, followed by the path to the .py file\n(including the file name extension) that defines the extension.\n\nTo explicitly disable an extension that is enabled in an hgrc of broader scope, prepend its\npath with !, as in foo = !/ext/path or foo = ! when path is not supplied.\n\nExample for ~/.hgrc:\n\n[extensions]\n# (the churn extension will get loaded from Mercurial's path)\nchurn =\n# (this extension will get loaded from the file specified)\nmyfeature = ~/.hgext/myfeature.py\n\nIf an extension fails to load, a warning will be issued, and Mercurial will proceed. To en‐\nforce that an extension must be loaded, one can set the required suboption in the config:\n\n[extensions]\nmyfeature = ~/.hgext/myfeature.py\nmyfeature:required = yes\n\nTo debug extension loading issue, one can add --traceback to their mercurial invocation.\n\nA default setting can we set using the special * extension key:\n\n[extensions]\n*:required = yes\nmyfeature = ~/.hgext/myfeature.py\nrebase=\n" }, { "name": "format", "content": "Configuration that controls the repository format. Newer format options are more powerful,\nbut incompatible with some older versions of Mercurial. Format options are considered at\nrepository initialization only. You need to make a new clone for config changes to be taken\ninto account.\n\nFor more details about repository format and version compatibility, see\nhttps://www.mercurial-scm.org/wiki/MissingRequirement\n" }, { "name": "usegeneraldelta", "content": "Enable or disable the \"generaldelta\" repository format which improves repository com‐\npression by allowing \"revlog\" to store deltas against arbitrary revisions instead of\nthe previously stored one. This provides significant improvement for repositories with\nbranches.\n\nRepositories with this on-disk format require Mercurial version 1.9.\n\nEnabled by default.\n" }, { "name": "dotencode", "content": "Enable or disable the \"dotencode\" repository format which enhances the \"fncache\"\nrepository format (which has to be enabled to use dotencode) to avoid issues with\nfilenames starting with \".\" on Mac OS X and spaces on Windows.\n\nRepositories with this on-disk format require Mercurial version 1.7.\n\nEnabled by default.\n" }, { "name": "usefncache", "content": "Enable or disable the \"fncache\" repository format which enhances the \"store\" reposi‐\ntory format (which has to be enabled to use fncache) to allow longer filenames and\navoids using Windows reserved names, e.g. \"nul\".\n\nRepositories with this on-disk format require Mercurial version 1.1.\n\nEnabled by default.\n" }, { "name": "use-dirstate-v2", "content": "Enable or disable the experimental \"dirstate-v2\" feature. The dirstate functionality\nis shared by all commands interacting with the working copy. The new version is more\nrobust, faster and stores more information.\n\nThe performance-improving version of this feature is currently only implemented in\nRust (see hg help rust), so people not using a version of Mercurial compiled with the\nRust parts might actually suffer some slowdown. For this reason, such versions will\nby default refuse to access repositories with \"dirstate-v2\" enabled.\n\nThis behavior can be adjusted via configuration: check hg help config.stor‐\nage.dirstate-v2.slow-path for details.\n\nRepositories with this on-disk format require Mercurial 6.0 or above.\n\nBy default this format variant is disabled if the fast implementation is not avail‐\nable, and enabled by default if the fast implementation is available.\n\nTo accomodate installations of Mercurial without the fast implementation, you can\ndowngrade your repository. To do so run the following command:\n\n$ hg debugupgraderepo\n--run --config format.use-dirstate-v2=False --config stor‐\nage.dirstate-v2.slow-path=allow\n\nFor a more comprehensive guide, see hg help internals.dirstate-v2.\n" }, { "name": "use-dirstate-v2.automatic-upgrade-of-mismatching-repositories", "content": "When enabled, an automatic upgrade will be triggered when a repository format does not\nmatch its use-dirstate-v2 config.\n\nThis is an advanced behavior that most users will not need. We recommend you don't use\nthis unless you are a seasoned administrator of a Mercurial install base.\n\nAutomatic upgrade means that any process accessing the repository will upgrade the\nrepository format to use dirstate-v2. This only triggers if a change is needed. This\nalso applies to operations that would have been read-only (like hg status).\n\nIf the repository cannot be locked, the automatic-upgrade operation will be skipped.\nThe next operation will attempt it again.\n\nThis configuration will apply for moves in any direction, either adding the\ndirstate-v2 format if format.use-dirstate-v2=yes or removing the dirstate-v2 require‐\nment if format.use-dirstate-v2=no. So we recommend setting both this value and for‐\nmat.use-dirstate-v2 at the same time.\n" }, { "name": "use-dirstate-v2.automatic-upgrade-of-mismatching-repositories:quiet", "content": "Hide message when performing such automatic upgrade.\n" }, { "name": "use-dirstate-tracked-hint", "content": "Enable or disable the writing of \"tracked key\" file alongside the dirstate. (default\nto disabled)\n\nThat \"tracked-hint\" can help external automations to detect changes to the set of\ntracked files. (i.e the result of hg files or hg status -macd)\n\nThe tracked-hint is written in a new .hg/dirstate-tracked-hint. That file contains two\nlines: - the first line is the file version (currently: 1), - the second line contains\nthe \"tracked-hint\". That file is written right after the dirstate is written.\n\nThe tracked-hint changes whenever the set of file tracked in the dirstate changes. The\ngeneral idea is: - if the hint is identical, the set of tracked file SHOULD be identi‐\ncal, - if the hint is different, the set of tracked file MIGHT be different.\n\nThe \"hint is identical\" case uses SHOULD as the dirstate and the hint file are two\ndistinct files and therefore that cannot be read or written to in an atomic way. If\nthe key is identical, nothing garantees that the dirstate is not updated right after\nthe hint file. This is considered a negligible limitation for the intended usecase. It\nis actually possible to prevent this race by taking the repository lock during read\noperations.\n\nThey are two \"ways\" to use this feature:\n\n1) monitoring changes to the .hg/dirstate-tracked-hint, if the file changes, the\ntracked set might have changed.\n\n2. storing the value and comparing it to a later value.\n" }, { "name": "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories", "content": "When enabled, an automatic upgrade will be triggered when a repository format does not\nmatch its use-dirstate-tracked-hint config.\n\nThis is an advanced behavior that most users will not need. We recommend you don't use\nthis unless you are a seasoned administrator of a Mercurial install base.\n\nAutomatic upgrade means that any process accessing the repository will upgrade the\nrepository format to use dirstate-tracked-hint. This only triggers if a change is\nneeded. This also applies to operations that would have been read-only (like hg sta‐\ntus).\n\nIf the repository cannot be locked, the automatic-upgrade operation will be skipped.\nThe next operation will attempt it again.\n\nThis configuration will apply for moves in any direction, either adding the\ndirstate-tracked-hint format if format.use-dirstate-tracked-hint=yes or removing the\ndirstate-tracked-hint requirement if format.use-dirstate-tracked-hint=no. So we recom‐\nmend setting both this value and format.use-dirstate-tracked-hint at the same time.\n" }, { "name": "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories:quiet", "content": "Hide message when performing such automatic upgrade.\n" }, { "name": "use-persistent-nodemap", "content": "Enable or disable the \"persistent-nodemap\" feature which improves performance if the\nRust extensions are available.\n\nThe \"persistent-nodemap\" persist the \"node -> rev\" on disk removing the need to dynam‐\nically build that mapping for each Mercurial invocation. This significantly reduces\nthe startup cost of various local and server-side operation for larger repositories.\n\nThe performance-improving version of this feature is currently only implemented in\nRust (see hg help rust), so people not using a version of Mercurial compiled with the\nRust parts might actually suffer some slowdown. For this reason, such versions will\nby default refuse to access repositories with \"persistent-nodemap\".\n\nThis behavior can be adjusted via configuration: check hg help config.stor‐\nage.revlog.persistent-nodemap.slow-path for details.\n\nRepositories with this on-disk format require Mercurial 5.4 or above.\n\nBy default this format variant is disabled if the fast implementation is not avail‐\nable, and enabled by default if the fast implementation is available.\n\nTo accomodate installations of Mercurial without the fast implementation, you can\ndowngrade your repository. To do so run the following command:\n\n$ hg debugupgraderepo\n--run --config format.use-persistent-nodemap=False --config storage.revlog.per‐\nsistent-nodemap.slow-path=allow\n" }, { "name": "use-share-safe", "content": "Enforce \"safe\" behaviors for all \"shares\" that access this repository.\n\nWith this feature, \"shares\" using this repository as a source will:\n\n• read the source repository's configuration (/.hg/hgrc).\n\n• read and use the source repository's \"requirements\" (except the working copy spe‐\ncific one).\n\nWithout this feature, \"shares\" using this repository as a source will:\n\n• keep tracking the repository \"requirements\" in the share only, ignoring the source\n\"requirements\", possibly diverging from them.\n\n• ignore source repository config. This can create problems, like silently ignoring\nimportant hooks.\n\nBeware that existing shares will not be upgraded/downgraded, and by default, Mercurial\nwill refuse to interact with them until the mismatch is resolved. See hg help con‐\nfig.share.safe-mismatch.source-safe and hg help config.share.safe-mis‐\nmatch.source-not-safe for details.\n\nIntroduced in Mercurial 5.7.\n\nEnabled by default in Mercurial 6.1.\n" }, { "name": "use-share-safe.automatic-upgrade-of-mismatching-repositories", "content": "When enabled, an automatic upgrade will be triggered when a repository format does not\nmatch its use-share-safe config.\n\nThis is an advanced behavior that most users will not need. We recommend you don't use\nthis unless you are a seasoned administrator of a Mercurial install base.\n\nAutomatic upgrade means that any process accessing the repository will upgrade the\nrepository format to use share-safe. This only triggers if a change is needed. This\nalso applies to operation that would have been read-only (like hg status).\n\nIf the repository cannot be locked, the automatic-upgrade operation will be skipped.\nThe next operation will attempt it again.\n\nThis configuration will apply for moves in any direction, either adding the share-safe\nformat if format.use-share-safe=yes or removing the share-safe requirement if for‐\nmat.use-share-safe=no. So we recommend setting both this value and for‐\nmat.use-share-safe at the same time.\n" }, { "name": "use-share-safe.automatic-upgrade-of-mismatching-repositories:quiet", "content": "Hide message when performing such automatic upgrade.\n" }, { "name": "usestore", "content": "Enable or disable the \"store\" repository format which improves compatibility with sys‐\ntems that fold case or otherwise mangle filenames. Disabling this option will allow\nyou to store longer filenames in some situations at the expense of compatibility.\n\nRepositories with this on-disk format require Mercurial version 0.9.4.\n\nEnabled by default.\n" }, { "name": "sparse-revlog", "content": "Enable or disable the sparse-revlog delta strategy. This format improves delta re-use\ninside revlog. For very branchy repositories, it results in a smaller store. For\nrepositories with many revisions, it also helps performance (by using shortened delta\nchains.)\n\nRepositories with this on-disk format require Mercurial version 4.7\n\nEnabled by default.\n" }, { "name": "revlog-compression", "content": "Compression algorithm used by revlog. Supported values are zlib and zstd. The zlib en‐\ngine is the historical default of Mercurial. zstd is a newer format that is usually a\nnet win over zlib, operating faster at better compression rates. Use zstd to reduce\nCPU usage. Multiple values can be specified, the first available one will be used.\n\nOn some systems, the Mercurial installation may lack zstd support.\n\nDefault is zstd if available, zlib otherwise.\n" }, { "name": "bookmarks-in-store", "content": "Store bookmarks in .hg/store/. This means that bookmarks are shared when using hg\nshare regardless of the -B option.\n\nRepositories with this on-disk format require Mercurial version 5.1.\n\nDisabled by default.\n" }, { "name": "graph", "content": "Web graph view configuration. This section let you change graph elements display properties\nby branches, for instance to make the default branch stand out.\n\nEach line has the following format:\n\n. = \n\nwhere is the name of the branch being customized. Example:\n\n[graph]\n# 2px width\ndefault.width = 2\n# red color\ndefault.color = FF0000\n\nSupported arguments:\n" }, { "name": "width", "content": "Set branch edges width in pixels.\n" }, { "name": "color", "content": "Set branch edges color in hexadecimal RGB notation.\n" }, { "name": "hooks", "content": "Commands or Python functions that get automatically executed by various actions such as\nstarting or finishing a commit. Multiple hooks can be run for the same action by appending a\nsuffix to the action. Overriding a site-wide hook can be done by changing its value or set‐\nting it to an empty string. Hooks can be prioritized by adding a prefix of priority. to the\nhook name on a new line and setting the priority. The default priority is 0.\n\nExample .hg/hgrc:\n\n[hooks]\n# update working directory after adding changesets\nchangegroup.update = hg update\n# do not use the site-wide hook\nincoming =\nincoming.email = /my/email/hook\nincoming.autobuild = /my/build/hook\n# force autobuild hook to run before other incoming hooks\npriority.incoming.autobuild = 1\n### control HGPLAIN setting when running autobuild hook\n# HGPLAIN always set (default from Mercurial 5.7)\nincoming.autobuild:run-with-plain = yes\n# HGPLAIN never set\nincoming.autobuild:run-with-plain = no\n# HGPLAIN inherited from environment (default before Mercurial 5.7)\nincoming.autobuild:run-with-plain = auto\n\nMost hooks are run with environment variables set that give useful additional information.\nFor each hook below, the environment variables it is passed are listed with names in the form\n$HGfoo. The $HGHOOKTYPE and $HGHOOKNAME variables are set for all hooks. They contain the\ntype of hook which triggered the run and the full name of the hook in the config, respec‐\ntively. In the example above, this will be $HGHOOKTYPE=incoming and $HGHOOKNAME=incom‐\ning.email.\n\nSome basic Unix syntax can be enabled for portability, including $VAR and ${VAR} style vari‐\nables. A ~ followed by \\ or / will be expanded to %USERPROFILE% to simulate a subset of\ntilde expansion on Unix. To use a literal $ or ~, it must be escaped with a back slash or\ninside of a strong quote. Strong quotes will be replaced by double quotes after processing.\n\nThis feature is enabled by adding a prefix of tonative. to the hook name on a new line, and\nsetting it to True. For example:\n\n[hooks]\nincoming.autobuild = /my/build/hook\n# enable translation to cmd.exe syntax for autobuild hook\ntonative.incoming.autobuild = True\n" }, { "name": "changegroup", "content": "Run after a changegroup has been added via push, pull or unbundle. The ID of the\nfirst new changeset is in $HGNODE and last is in $HGNODELAST. The URL from which\nchanges came is in $HGURL.\n" }, { "name": "commit", "content": "Run after a changeset has been created in the local repository. The ID of the newly\ncreated changeset is in $HGNODE. Parent changeset IDs are in $HGPARENT1 and $HGPAR‐\nENT2.\n" }, { "name": "incoming", "content": "Run after a changeset has been pulled, pushed, or unbundled into the local repository.\nThe ID of the newly arrived changeset is in $HGNODE. The URL that was source of the\nchanges is in $HGURL.\n" }, { "name": "outgoing", "content": "Run after sending changes from the local repository to another. The ID of first\nchangeset sent is in $HGNODE. The source of operation is in $HGSOURCE. Also see hg\nhelp config.hooks.preoutgoing.\n" }, { "name": "post-", "content": "Run after successful invocations of the associated command. The contents of the com‐\nmand line are passed as $HGARGS and the result code in $HGRESULT. Parsed command\nline arguments are passed as $HGPATS and $HGOPTS. These contain string representa‐\ntions of the python data internally passed to . $HGOPTS is a dictionary of\noptions (with unspecified options set to their defaults). $HGPATS is a list of argu‐\nments. Hook failure is ignored.\n" }, { "name": "fail-", "content": "Run after a failed invocation of an associated command. The contents of the command\nline are passed as $HGARGS. Parsed command line arguments are passed as $HGPATS and\n$HGOPTS. These contain string representations of the python data internally passed to\n. $HGOPTS is a dictionary of options (with unspecified options set to their\ndefaults). $HGPATS is a list of arguments. Hook failure is ignored.\n" }, { "name": "pre-", "content": "Run before executing the associated command. The contents of the command line are\npassed as $HGARGS. Parsed command line arguments are passed as $HGPATS and $HGOPTS.\nThese contain string representations of the data internally passed to .\n$HGOPTS is a dictionary of options (with unspecified options set to their defaults).\n$HGPATS is a list of arguments. If the hook returns failure, the command doesn't exe‐\ncute and Mercurial returns the failure code.\n" }, { "name": "prechangegroup", "content": "Run before a changegroup is added via push, pull or unbundle. Exit status 0 allows the\nchangegroup to proceed. A non-zero status will cause the push, pull or unbundle to\nfail. The URL from which changes will come is in $HGURL.\n" }, { "name": "precommit", "content": "Run before starting a local commit. Exit status 0 allows the commit to proceed. A\nnon-zero status will cause the commit to fail. Parent changeset IDs are in $HGPAR‐\nENT1 and $HGPARENT2.\n" }, { "name": "prelistkeys", "content": "Run before listing pushkeys (like bookmarks) in the repository. A non-zero status will\ncause failure. The key namespace is in $HGNAMESPACE.\n" }, { "name": "preoutgoing", "content": "Run before collecting changes to send from the local repository to another. A non-zero\nstatus will cause failure. This lets you prevent pull over HTTP or SSH. It can also\nprevent propagating commits (via local pull, push (outbound) or bundle commands), but\nnot completely, since you can just copy files instead. The source of operation is in\n$HGSOURCE. If \"serve\", the operation is happening on behalf of a remote SSH or HTTP\nrepository. If \"push\", \"pull\" or \"bundle\", the operation is happening on behalf of a\nrepository on same system.\n" }, { "name": "prepushkey", "content": "Run before a pushkey (like a bookmark) is added to the repository. A non-zero status\nwill cause the key to be rejected. The key namespace is in $HGNAMESPACE, the key is\nin $HGKEY, the old value (if any) is in $HGOLD, and the new value is in $HGNEW.\n" }, { "name": "pretag", "content": "Run before creating a tag. Exit status 0 allows the tag to be created. A non-zero sta‐\ntus will cause the tag to fail. The ID of the changeset to tag is in $HGNODE. The\nname of tag is in $HGTAG. The tag is local if $HGLOCAL=1, or in the repository if\n$HGLOCAL=0.\n" }, { "name": "pretransmit-inline-clone-bundle", "content": "Run before transferring an inline clonebundle to the peer. If the exit status is 0,\nthe inline clonebundle will be allowed to be transferred. A non-zero status will cause\nthe transfer to fail. The path of the inline clonebundle is in $HGCLONEBUNDLEPATH.\n" }, { "name": "pretxnopen", "content": "Run before any new repository transaction is open. The reason for the transaction will\nbe in $HGTXNNAME, and a unique identifier for the transaction will be in $HGTXNID. A\nnon-zero status will prevent the transaction from being opened.\n" }, { "name": "pretxnclose", "content": "Run right before the transaction is actually finalized. Any repository change will be\nvisible to the hook program. This lets you validate the transaction content or change\nit. Exit status 0 allows the commit to proceed. A non-zero status will cause the\ntransaction to be rolled back. The reason for the transaction opening will be in\n$HGTXNNAME, and a unique identifier for the transaction will be in $HGTXNID. The\nrest of the available data will vary according the transaction type. Changes unbun‐\ndled to the repository will add $HGURL and $HGSOURCE. New changesets will add\n$HGNODE (the ID of the first added changeset), $HGNODELAST (the ID of the last\nadded changeset). Bookmark and phase changes will set $HGBOOKMARKMOVED and\n$HGPHASESMOVED to 1 respectively. The number of new obsmarkers, if any, will be in\n$HGNEWOBSMARKERS, etc.\n" }, { "name": "pretxnclose-bookmark", "content": "Run right before a bookmark change is actually finalized. Any repository change will\nbe visible to the hook program. This lets you validate the transaction content or\nchange it. Exit status 0 allows the commit to proceed. A non-zero status will cause\nthe transaction to be rolled back. The name of the bookmark will be available in\n$HGBOOKMARK, the new bookmark location will be available in $HGNODE while the previ‐\nous location will be available in $HGOLDNODE. In case of a bookmark creation\n$HGOLDNODE will be empty. In case of deletion $HGNODE will be empty. In addition,\nthe reason for the transaction opening will be in $HGTXNNAME, and a unique identifier\nfor the transaction will be in $HGTXNID.\n" }, { "name": "pretxnclose-phase", "content": "Run right before a phase change is actually finalized. Any repository change will be\nvisible to the hook program. This lets you validate the transaction content or change\nit. Exit status 0 allows the commit to proceed. A non-zero status will cause the\ntransaction to be rolled back. The hook is called multiple times, once for each revi‐\nsion affected by a phase change. The affected node is available in $HGNODE, the\nphase in $HGPHASE while the previous $HGOLDPHASE. In case of new node, $HGOLDPHASE\nwill be empty. In addition, the reason for the transaction opening will be in\n$HGTXNNAME, and a unique identifier for the transaction will be in $HGTXNID. The\nhook is also run for newly added revisions. In this case the $HGOLDPHASE entry will\nbe empty.\n" }, { "name": "txnclose", "content": "Run after any repository transaction has been committed. At this point, the transac‐\ntion can no longer be rolled back. The hook will run after the lock is released. See\nhg help config.hooks.pretxnclose for details about available variables.\n" }, { "name": "txnclose-bookmark", "content": "Run after any bookmark change has been committed. At this point, the transaction can\nno longer be rolled back. The hook will run after the lock is released. See hg help\nconfig.hooks.pretxnclose-bookmark for details about available variables.\n" }, { "name": "txnclose-phase", "content": "Run after any phase change has been committed. At this point, the transaction can no\nlonger be rolled back. The hook will run after the lock is released. See hg help con‐\nfig.hooks.pretxnclose-phase for details about available variables.\n" }, { "name": "txnabort", "content": "Run when a transaction is aborted. See hg help config.hooks.pretxnclose for details\nabout available variables.\n" }, { "name": "pretxnchangegroup", "content": "Run after a changegroup has been added via push, pull or unbundle, but before the\ntransaction has been committed. The changegroup is visible to the hook program. This\nallows validation of incoming changes before accepting them. The ID of the first new\nchangeset is in $HGNODE and last is in $HGNODELAST. Exit status 0 allows the trans‐\naction to commit. A non-zero status will cause the transaction to be rolled back, and\nthe push, pull or unbundle will fail. The URL that was the source of changes is in\n$HGURL.\n" }, { "name": "pretxncommit", "content": "Run after a changeset has been created, but before the transaction is committed. The\nchangeset is visible to the hook program. This allows validation of the commit message\nand changes. Exit status 0 allows the commit to proceed. A non-zero status will cause\nthe transaction to be rolled back. The ID of the new changeset is in $HGNODE. The\nparent changeset IDs are in $HGPARENT1 and $HGPARENT2.\n" }, { "name": "preupdate", "content": "Run before updating the working directory. Exit status 0 allows the update to proceed.\nA non-zero status will prevent the update. The changeset ID of first new parent is in\n$HGPARENT1. If updating to a merge, the ID of second new parent is in $HGPARENT2.\n" }, { "name": "listkeys", "content": "Run after listing pushkeys (like bookmarks) in the repository. The key namespace is in\n$HGNAMESPACE. $HGVALUES is a dictionary containing the keys and values.\n" }, { "name": "pushkey", "content": "Run after a pushkey (like a bookmark) is added to the repository. The key namespace is\nin $HGNAMESPACE, the key is in $HGKEY, the old value (if any) is in $HGOLD, and the\nnew value is in $HGNEW.\n" }, { "name": "tag", "content": "Run after a tag is created. The ID of the tagged changeset is in $HGNODE. The name\nof tag is in $HGTAG. The tag is local if $HGLOCAL=1, or in the repository if $HGLO‐\nCAL=0.\n" }, { "name": "update", "content": "Run after updating the working directory. The changeset ID of first new parent is in\n$HGPARENT1. If updating to a merge, the ID of second new parent is in $HGPARENT2. If\nthe update succeeded, $HGERROR=0. If the update failed (e.g. because conflicts were\nnot resolved), $HGERROR=1.\n\nNote It is generally better to use standard hooks rather than the generic pre- and post-\ncommand hooks, as they are guaranteed to be called in the appropriate contexts for in‐\nfluencing transactions. Also, hooks like \"commit\" will be called in all contexts that\ngenerate a commit (e.g. tag) and not just the commit command.\n\nNote Environment variables with empty values may not be passed to hooks on platforms such\nas Windows. As an example, $HGPARENT2 will have an empty value under Unix-like plat‐\nforms for non-merge changesets, while it will not be available at all under Windows.\n\nThe syntax for Python hooks is as follows:\n\nhookname = python:modulename.submodule.callable\nhookname = python:/path/to/python/module.py:callable\n\nPython hooks are run within the Mercurial process. Each hook is called with at least three\nkeyword arguments: a ui object (keyword ui), a repository object (keyword repo), and a hook‐\ntype keyword that tells what kind of hook is used. Arguments listed as environment variables\nabove are passed as keyword arguments, with no HG prefix, and names in lower case.\n\nIf a Python hook returns a \"true\" value or raises an exception, this is treated as a failure.\n" }, { "name": "hostfingerprints", "content": "(Deprecated. Use [hostsecurity]'s fingerprints options instead.)\n\nFingerprints of the certificates of known HTTPS servers.\n\nA HTTPS connection to a server with a fingerprint configured here will only succeed if the\nservers certificate matches the fingerprint. This is very similar to how ssh known hosts\nworks.\n\nThe fingerprint is the SHA-1 hash value of the DER encoded certificate. Multiple values can\nbe specified (separated by spaces or commas). This can be used to define both old and new\nfingerprints while a host transitions to a new certificate.\n\nThe CA chain and web.cacerts is not used for servers with a fingerprint.\n\nFor example:\n\n[hostfingerprints]\nhg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33\nhg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33\n" }, { "name": "hostsecurity", "content": "Used to specify global and per-host security settings for connecting to other machines.\n\nThe following options control default behavior for all hosts.\n" }, { "name": "ciphers", "content": "Defines the cryptographic ciphers to use for connections.\n\nValue must be a valid OpenSSL Cipher List Format as documented at\nhttps://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.\n\nThis setting is for advanced users only. Setting to incorrect values can significantly\nlower connection security or decrease performance. You have been warned.\n\nThis option requires Python 2.7.\n" }, { "name": "minimumprotocol", "content": "Defines the minimum channel encryption protocol to use.\n\nBy default, the highest version of TLS supported by both client and server is used.\n\nAllowed values are: tls1.0, tls1.1, tls1.2.\n\nWhen running on an old Python version, only tls1.0 is allowed since old versions of\nPython only support up to TLS 1.0.\n\nWhen running a Python that supports modern TLS versions, the default is tls1.1. tls1.0\ncan still be used to allow TLS 1.0. However, this weakens security and should only be\nused as a feature of last resort if a server does not support TLS 1.1+.\n\nOptions in the [hostsecurity] section can have the form hostname:setting. This allows multi‐\nple settings to be defined on a per-host basis.\n\nThe following per-host settings can be defined.\n" }, { "name": "ciphers", "content": "This behaves like ciphers as described above except it only applies to the host on\nwhich it is defined.\n" }, { "name": "fingerprints", "content": "A list of hashes of the DER encoded peer/remote certificate. Values have the form al‐\ngorithm:fingerprint. e.g.\nsha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2. In addition,\ncolons (:) can appear in the fingerprint part.\n\nThe following algorithms/prefixes are supported: sha1, sha256, sha512.\n\nUse of sha256 or sha512 is preferred.\n\nIf a fingerprint is specified, the CA chain is not validated for this host and Mercur‐\nial will require the remote certificate to match one of the fingerprints specified.\nThis means if the server updates its certificate, Mercurial will abort until a new\nfingerprint is defined. This can provide stronger security than traditional CA-based\nvalidation at the expense of convenience.\n\nThis option takes precedence over verifycertsfile.\n" }, { "name": "minimumprotocol", "content": "This behaves like minimumprotocol as described above except it only applies to the\nhost on which it is defined.\n" }, { "name": "verifycertsfile", "content": "Path to file a containing a list of PEM encoded certificates used to verify the server\ncertificate. Environment variables and ~user constructs are expanded in the filename.\n\nThe server certificate or the certificate's certificate authority (CA) must match a\ncertificate from this file or certificate verification will fail and connections to\nthe server will be refused.\n\nIf defined, only certificates provided by this file will be used: web.cacerts and any\nsystem/default certificates will not be used.\n\nThis option has no effect if the per-host fingerprints option is set.\n\nThe format of the file is as follows:\n\n-----BEGIN CERTIFICATE-----\n... (certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n... (certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n\nFor example:\n\n[hostsecurity]\nhg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2\nhg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33\nhg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2\nfoo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem\n\nTo change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1 when connect‐\ning to hg.example.com:\n\n[hostsecurity]\nminimumprotocol = tls1.2\nhg.example.com:minimumprotocol = tls1.1\n" }, { "name": "http_proxy", "content": "Used to access web-based Mercurial repositories through a HTTP proxy.\n" }, { "name": "host", "content": "Host name and (optional) port of the proxy server, for example \"myproxy:8000\".\n\nno\n\nOptional. Comma-separated list of host names that should bypass the proxy.\n" }, { "name": "passwd", "content": "Optional. Password to authenticate with at the proxy server.\n" }, { "name": "user", "content": "Optional. User name to authenticate with at the proxy server.\n" }, { "name": "always", "content": "Optional. Always use the proxy, even for localhost and any entries in httpproxy.no.\n(default: False)\n" }, { "name": "http", "content": "Used to configure access to Mercurial repositories via HTTP.\n" }, { "name": "timeout", "content": "If set, blocking operations will timeout after that many seconds. (default: None)\n" }, { "name": "merge", "content": "This section specifies behavior during merges and updates.\n" }, { "name": "checkignored", "content": "Controls behavior when an ignored file on disk has the same name as a tracked file in\nthe changeset being merged or updated to, and has different contents. Options are\nabort, warn and ignore. With abort, abort on such files. With warn, warn on such files\nand back them up as .orig. With ignore, don't print a warning and back them up as\n.orig. (default: abort)\n" }, { "name": "checkunknown", "content": "Controls behavior when an unknown file that isn't ignored has the same name as a\ntracked file in the changeset being merged or updated to, and has different contents.\nSimilar to merge.checkignored, except for files that are not ignored. (default: abort)\n" }, { "name": "on-failure", "content": "When set to continue (the default), the merge process attempts to merge all unresolved\nfiles using the merge chosen tool, regardless of whether previous file merge attempts\nduring the process succeeded or not. Setting this to prompt will prompt after any\nmerge failure continue or halt the merge process. Setting this to halt will automati‐\ncally halt the merge process on any merge tool failure. The merge process can be\nrestarted by using the resolve command. When a merge is halted, the repository is left\nin a normal unresolved merge state. (default: continue)\n" }, { "name": "strict-capability-check", "content": "Whether capabilities of internal merge tools are checked strictly or not, while exam‐\nining rules to decide merge tool to be used. (default: False)\n" }, { "name": "merge-patterns", "content": "This section specifies merge tools to associate with particular file patterns. Tools matched\nhere will take precedence over the default merge tool. Patterns are globs by default, rooted\nat the repository root.\n\nExample:\n\n[merge-patterns]\n.c = kdiff3\n.jpg = myimgmerge\n" }, { "name": "merge-tools", "content": "This section configures external merge tools to use for file-level merges. This section has\nlikely been preconfigured at install time. Use hg config merge-tools to check the existing\nconfiguration. Also see hg help merge-tools for more details.\n\nExample ~/.hgrc:\n\n[merge-tools]\n# Override stock tool location\nkdiff3.executable = ~/bin/kdiff3\n# Specify command line\nkdiff3.args = $base $local $other -o $output\n# Give higher priority\nkdiff3.priority = 1\n\n# Changing the priority of preconfigured tool\nmeld.priority = 0\n\n# Disable a preconfigured tool\nvimdiff.disabled = yes\n\n# Define new tool\nmyHtmlTool.args = -m $local $other $base $output\nmyHtmlTool.regkey = Software\\FooSoftware\\HtmlMerge\nmyHtmlTool.priority = 1\n\nSupported arguments:\n" }, { "name": "priority", "content": "The priority in which to evaluate this tool. (default: 0)\n" }, { "name": "executable", "content": "Either just the name of the executable or its pathname.\n\nOn Windows, the path can use environment variables with ${ProgramFiles} syntax.\n\n(default: the tool name)\n" }, { "name": "args", "content": "The arguments to pass to the tool executable. You can refer to the files being merged\nas well as the output file through these variables: $base, $local, $other, $output.\n\nThe meaning of $local and $other can vary depending on which action is being per‐\nformed. During an update or merge, $local represents the original state of the file,\nwhile $other represents the commit you are updating to or the commit you are merging\nwith. During a rebase, $local represents the destination of the rebase, and $other\nrepresents the commit being rebased.\n\nSome operations define custom labels to assist with identifying the revisions, acces‐\nsible via $labellocal, $labelother, and $labelbase. If custom labels are not avail‐\nable, these will be local, other, and base, respectively. (default: $local $base\n$other)\n" }, { "name": "premerge", "content": "Attempt to run internal non-interactive 3-way merge tool before launching external\ntool. Options are true, false, keep, keep-merge3, or keep-mergediff (experimental).\nThe keep option will leave markers in the file if the premerge fails. The keep-merge3\nwill do the same but include information about the base of the merge in the marker\n(see internal :merge3 in hg help merge-tools). The keep-mergediff option is similar\nbut uses a different marker style (see internal :merge3 in hg help merge-tools). (de‐\nfault: True)\n" }, { "name": "binary", "content": "This tool can merge binary files. (default: False, unless tool was selected by file\npattern match)\n" }, { "name": "symlink", "content": "This tool can merge symlinks. (default: False)\n" }, { "name": "check", "content": "A list of merge success-checking options:\n\nchanged\n\nAsk whether merge was successful when the merged file shows no changes.\n\nconflicts\n\nCheck whether there are conflicts even though the tool reported success.\n\nprompt\n\nAlways prompt for merge success, regardless of success reported by tool.\n" }, { "name": "fixeol", "content": "Attempt to fix up EOL changes caused by the merge tool. (default: False)\n" }, { "name": "gui", "content": "This tool requires a graphical interface to run. (default: False)\n" }, { "name": "mergemarkers", "content": "Controls whether the labels passed via $labellocal, $labelother, and $labelbase are\ndetailed (respecting mergemarkertemplate) or basic. If premerge is keep or\nkeep-merge3, the conflict markers generated during premerge will be detailed if either\nthis option or the corresponding option in the [ui] section is detailed. (default:\nbasic)\n" }, { "name": "mergemarkertemplate", "content": "This setting can be used to override mergemarker from the [command-templates] section\non a per-tool basis; this applies to the $label-prefixed variables and to the conflict\nmarkers that are generated if premerge is keep` or ``keep-merge3. See the correspond‐\ning variable in [ui] for more information.\n" }, { "name": "regkey", "content": "Windows registry key which describes install location of this tool. Mercurial will\nsearch for this key first under HKEYCURRENTUSER and then under HKEYLOCALMACHINE.\n(default: None)\n" }, { "name": "regkeyalt", "content": "An alternate Windows registry key to try if the first key is not found. The alternate\nkey uses the same regname and regappend semantics of the primary key. The most common\nuse for this key is to search for 32bit applications on 64bit operating systems. (de‐\nfault: None)\n" }, { "name": "regname", "content": "Name of value to read from specified registry key. (default: the unnamed (default)\nvalue)\n" }, { "name": "regappend", "content": "String to append to the value read from the registry, typically the executable name of\nthe tool. (default: None)\n" }, { "name": "pager", "content": "Setting used to control when to paginate and with what external tool. See hg help pager for\ndetails.\n" }, { "name": "pager", "content": "Define the external tool used as pager.\n\nIf no pager is set, Mercurial uses the environment variable $PAGER. If neither\npager.pager, nor $PAGER is set, a default pager will be used, typically less on Unix\nand more on Windows. Example:\n\n[pager]\npager = less -FRX\n" }, { "name": "ignore", "content": "List of commands to disable the pager for. Example:\n\n[pager]\nignore = version, help, update\n" }, { "name": "patch", "content": "Settings used when applying patches, for instance through the 'import' command or with Mercu‐\nrial Queues extension.\n" }, { "name": "eol", "content": "When set to 'strict' patch content and patched files end of lines are preserved. When\nset to lf or crlf, both files end of lines are ignored when patching and the result\nline endings are normalized to either LF (Unix) or CRLF (Windows). When set to auto,\nend of lines are again ignored while patching but line endings in patched files are\nnormalized to their original setting on a per-file basis. If target file does not ex‐\nist or has no end of line, patch line endings are preserved. (default: strict)\n" }, { "name": "fuzz", "content": "The number of lines of 'fuzz' to allow when applying patches. This controls how much\ncontext the patcher is allowed to ignore when trying to apply a patch. (default: 2)\n" }, { "name": "paths", "content": "Assigns symbolic names and behavior to repositories.\n\nOptions are symbolic names defining the URL or directory that is the location of the reposi‐\ntory. Example:\n\n[paths]\nmyserver = https://example.com/myrepo\nlocalpath = /home/me/repo\n\nThese symbolic names can be used from the command line. To pull from myserver: hg pull\nmyserver. To push to localpath: hg push localpath. You can check hg help urls for details\nabout valid URLs.\n\nOptions containing colons (:) denote sub-options that can influence behavior for that spe‐\ncific path. Example:\n\n[paths]\nmyserver = https://example.com/mypath\nmyserver:pushurl = ssh://example.com/mypath\n\nPaths using the path://otherpath scheme will inherit the sub-options value from the path they\npoint to.\n\nThe following sub-options can be defined:\n" }, { "name": "multi-urls", "content": "A boolean option. When enabled the value of the [paths] entry will be parsed as a list\nand the alias will resolve to multiple destination. If some of the list entry use the\npath:// syntax, the suboption will be inherited individually.\n" }, { "name": "pushurl", "content": "The URL to use for push operations. If not defined, the location defined by the path's\nmain entry is used.\n" }, { "name": "pushrev", "content": "A revset defining which revisions to push by default.\n\nWhen hg push is executed without a -r argument, the revset defined by this sub-option\nis evaluated to determine what to push.\n\nFor example, a value of . will push the working directory's revision by default.\n\nRevsets specifying bookmarks will not result in the bookmark being pushed.\n" }, { "name": "bookmarks.mode", "content": "How bookmark will be dealt during the exchange. It support the following value\n\n• default: the default behavior, local and remote bookmarks are \"merged\" on push/pull.\n\n• mirror: when pulling, replace local bookmarks by remote bookmarks. This is useful to\nreplicate a repository, or as an optimization.\n\n• ignore: ignore bookmarks during exchange. (This currently only affect pulling)\n\npulled-delta-reuse-policy Control the policy regarding deltas sent by the remote during\npulls.\n\nThis is an advanced option that non-admin users should not need to understand or set. This\noption can be used to speed up pulls from trusted central servers, or to fix-up deltas from\nolder servers.\n\nIt supports the following values:\n\n• default: use the policy defined by storage.revlog.reuse-external-delta-parent,\n\n• no-reuse: start a new optimal delta search for each new revision we add to the repository.\nThe deltas from the server will be reused when the base it applies to is tested (this can\nbe frequent if that base is the one and unique parent of that revision). This can signifi‐\ncantly slowdown pulls but will result in an optimized storage space if the remote peer is\nsending poor quality deltas.\n\n• try-base: try to reuse the deltas from the remote peer as long as they create a valid\ndelta-chain in the local repository. This speeds up the unbundling process, but can result\nin sub-optimal storage space if the remote peer is sending poor quality deltas.\n\n• forced: the deltas from the peer will be reused in all cases, even if the resulting\ndelta-chain is \"invalid\". This setting will ensure the bundle is applied at minimal CPU\ncost, but it can result in longer delta chains being created on the client, making revi‐\nsions potentially slower to access in the future. If you think you need this option, you\nshould make sure you are also talking to the Mercurial developer community to get confirma‐\ntion.\n\nSee hg help config.storage.revlog.reuse-external-delta-parent for a similar global option.\nThat option defines the behavior of default.\n\nThe following special named paths exist:\n" }, { "name": "default", "content": "The URL or directory to use when no source or remote is specified.\n\nhg clone will automatically define this path to the location the repository was cloned\nfrom.\n" }, { "name": "default-push", "content": "(deprecated) The URL or directory for the default hg push location. default:pushurl\nshould be used instead.\n" }, { "name": "phases", "content": "Specifies default handling of phases. See hg help phases for more information about working\nwith phases.\n" }, { "name": "publish", "content": "Controls draft phase behavior when working as a server. When true, pushed changesets\nare set to public in both client and server and pulled or cloned changesets are set to\npublic in the client. (default: True)\n" }, { "name": "new-commit", "content": "Phase of newly-created commits. (default: draft)\n" }, { "name": "checksubrepos", "content": "Check the phase of the current revision of each subrepository. Allowed values are \"ig‐\nnore\", \"follow\" and \"abort\". For settings other than \"ignore\", the phase of the cur‐\nrent revision of each subrepository is checked before committing the parent reposi‐\ntory. If any of those phases is greater than the phase of the parent repository (e.g.\nif a subrepo is in a \"secret\" phase while the parent repo is in \"draft\" phase), the\ncommit is either aborted (if checksubrepos is set to \"abort\") or the higher phase is\nused for the parent repository commit (if set to \"follow\"). (default: follow)\n" }, { "name": "profiling", "content": "Specifies profiling type, format, and file output. Two profilers are supported: an instru‐\nmenting profiler (named ls), and a sampling profiler (named stat).\n\nIn this section description, 'profiling data' stands for the raw data collected during pro‐\nfiling, while 'profiling report' stands for a statistical text report generated from the pro‐\nfiling data.\n" }, { "name": "enabled", "content": "Enable the profiler. (default: false)\n\nThis is equivalent to passing --profile on the command line.\n" }, { "name": "type", "content": "The type of profiler to use. (default: stat)\n\nls\n\nUse Python's built-in instrumenting profiler. This profiler works on all plat‐\nforms, but each line number it reports is the first line of a function. This\nrestriction makes it difficult to identify the expensive parts of a non-trivial\nfunction.\n\nstat\n\nUse a statistical profiler, statprof. This profiler is most useful for profil‐\ning commands that run for longer than about 0.1 seconds.\n" }, { "name": "format", "content": "Profiling format. Specific to the ls instrumenting profiler. (default: text)\n\ntext\n\nGenerate a profiling report. When saving to a file, it should be noted that\nonly the report is saved, and the profiling data is not kept.\n\nkcachegrind\n\nFormat profiling data for kcachegrind use: when saving to a file, the generated\nfile can directly be loaded into kcachegrind.\n" }, { "name": "statformat", "content": "Profiling format for the stat profiler. (default: hotpath)\n\nhotpath\n\nShow a tree-based display containing the hot path of execution (where most time\nwas spent).\n\nbymethod\n\nShow a table of methods ordered by how frequently they are active.\n\nbyline\n\nShow a table of lines in files ordered by how frequently they are active.\n\njson\n\nRender profiling data as JSON.\n" }, { "name": "freq", "content": "Sampling frequency. Specific to the stat sampling profiler. (default: 1000)\n" }, { "name": "output", "content": "File path where profiling data or report should be saved. If the file exists, it is\nreplaced. (default: None, data is printed on stderr)\n" }, { "name": "sort", "content": "Sort field. Specific to the ls instrumenting profiler. One of callcount, reccall‐\ncount, totaltime and inlinetime. (default: inlinetime)\n" }, { "name": "time-track", "content": "Control if the stat profiler track cpu or real time. (default: cpu on Windows, other‐\nwise real)\n" }, { "name": "limit", "content": "Number of lines to show. Specific to the ls instrumenting profiler. (default: 30)\n" }, { "name": "nested", "content": "Show at most this number of lines of drill-down info after each main entry. This can\nhelp explain the difference between Total and Inline. Specific to the ls instrument‐\ning profiler. (default: 0)\n" }, { "name": "showmin", "content": "Minimum fraction of samples an entry must have for it to be displayed. Can be speci‐\nfied as a float between 0.0 and 1.0 or can have a % afterwards to allow values up to\n100. e.g. 5%.\n\nOnly used by the stat profiler.\n\nFor the hotpath format, default is 0.05. For the chrome format, default is 0.005.\n\nThe option is unused on other formats.\n" }, { "name": "showmax", "content": "Maximum fraction of samples an entry can have before it is ignored in display. Values\nformat is the same as showmin.\n\nOnly used by the stat profiler.\n\nFor the chrome format, default is 0.999.\n\nThe option is unused on other formats.\n" }, { "name": "showtime", "content": "Show time taken as absolute durations, in addition to percentages. Only used by the\nhotpath format. (default: true)\n" }, { "name": "progress", "content": "Mercurial commands can draw progress bars that are as informative as possible. Some progress\nbars only offer indeterminate information, while others have a definite end point.\n" }, { "name": "debug", "content": "Whether to print debug info when updating the progress bar. (default: False)\n" }, { "name": "delay", "content": "Number of seconds (float) before showing the progress bar. (default: 3)\n" }, { "name": "changedelay", "content": "Minimum delay before showing a new topic. When set to less than 3 * refresh, that\nvalue will be used instead. (default: 1)\n" }, { "name": "estimateinterval", "content": "Maximum sampling interval in seconds for speed and estimated time calculation. (de‐\nfault: 60)\n" }, { "name": "refresh", "content": "Time in seconds between refreshes of the progress bar. (default: 0.1)\n" }, { "name": "format", "content": "Format of the progress bar.\n\nValid entries for the format field are topic, bar, number, unit, estimate, speed, and\nitem. item defaults to the last 20 characters of the item, but this can be changed by\nadding either - which would take the last num characters, or + for the first\nnum characters.\n\n(default: topic bar number estimate)\n" }, { "name": "width", "content": "If set, the maximum width of the progress information (that is, min(width, term width)\nwill be used).\n" }, { "name": "clear-complete", "content": "Clear the progress bar after it's done. (default: True)\n" }, { "name": "disable", "content": "If true, don't show a progress bar.\n" }, { "name": "assume-tty", "content": "If true, ALWAYS show a progress bar, unless disable is given.\n" }, { "name": "rebase", "content": "" }, { "name": "evolution.allowdivergence", "content": "Default to False, when True allow creating divergence when performing rebase of obso‐\nlete changesets.\n" }, { "name": "revsetalias", "content": "Alias definitions for revsets. See hg help revsets for details.\n" }, { "name": "rewrite", "content": "" }, { "name": "backup-bundle", "content": "Whether to save stripped changesets to a bundle file. (default: True)\n" }, { "name": "update-timestamp", "content": "If true, updates the date and time of the changeset to current. It is only applicable\nfor hg amend, hg commit --amend and hg uncommit in the current version.\n" }, { "name": "empty-successor", "content": "Control what happens with empty successors that are the result of rewrite operations. If\nset to skip, the successor is not created. If set to keep, the empty successor is created\nand kept.\n\nCurrently, only the rebase and absorb commands consider this configuration. (EXPERIMEN‐\nTAL)\n" }, { "name": "rhg", "content": "The pure Rust fast-path for Mercurial. See rust/README.rst in the Mercurial repository.\n" }, { "name": "fallback-executable", "content": "Path to the executable to run in a sub-process when falling back to another implemen‐\ntation of Mercurial.\n" }, { "name": "fallback-immediately", "content": "Fall back to fallback-executable as soon as possible, regardless of the rhg.on-unsup‐\nported configuration. Useful for debugging, for example to bypass rhg if the deault hg\npoints to rhg.\n\nNote that because this requires loading the configuration, it is possible that rhg er‐\nror out before being able to fall back.\n" }, { "name": "ignored-extensions", "content": "Controls which extensions should be ignored by rhg. By default, rhg triggers the\nrhg.on-unsupported behavior any unsupported extensions. Users can disable that behav‐\nior when they know that a given extension does not need support from rhg.\n\nExpects a list of extension names, or * to ignore all extensions.\n\nNote: *: is also a valid extension name for this configuration option. As\nof this writing, the only valid \"global\" suboption is required.\n" }, { "name": "on-unsupported", "content": "Controls the behavior of rhg when detecting unsupported features.\n\nPossible values are abort (default), abort-silent and fallback.\n\nabort\n\nPrint an error message describing what feature is not supported, and exit with\ncode 252\n\nabort-silent\n\nSilently exit with code 252\n\nfallback\n\nTry running the fallback executable with the same parameters (and trace the\nfallback reason, use RUSTLOG=trace to see).\n" }, { "name": "share", "content": "" }, { "name": "safe-mismatch.source-safe", "content": "Controls what happens when the shared repository does not use the share-safe mechanism\nbut its source repository does.\n\nPossible values are abort (default), allow, upgrade-abort and upgrade-allow.\n\nabort\n\nDisallows running any command and aborts\n\nallow\n\nRespects the feature presence in the share source\n\nupgrade-abort\n\nTries to upgrade the share to use share-safe; if it fails, aborts\n\nupgrade-allow\n\nTries to upgrade the share; if it fails, continue by respecting the share\nsource setting\n\nCheck hg help config.format.use-share-safe for details about the share-safe feature.\n" }, { "name": "safe-mismatch.source-safe:verbose-upgrade", "content": "Display a message when upgrading, (default: True)\n" }, { "name": "safe-mismatch.source-safe.warn", "content": "Shows a warning on operations if the shared repository does not use share-safe, but\nthe source repository does. (default: True)\n" }, { "name": "safe-mismatch.source-not-safe", "content": "Controls what happens when the shared repository uses the share-safe mechanism but its\nsource does not.\n\nPossible values are abort (default), allow, downgrade-abort and downgrade-allow.\n\nabort\n\nDisallows running any command and aborts\n\nallow\n\nRespects the feature presence in the share source\n\ndowngrade-abort\n\nTries to downgrade the share to not use share-safe; if it fails, aborts\n\ndowngrade-allow\n\nTries to downgrade the share to not use share-safe; if it fails, continue by\nrespecting the shared source setting\n\nCheck hg help config.format.use-share-safe for details about the share-safe feature.\n" }, { "name": "safe-mismatch.source-not-safe:verbose-upgrade", "content": "Display a message when upgrading, (default: True)\n" }, { "name": "safe-mismatch.source-not-safe.warn", "content": "Shows a warning on operations if the shared repository uses share-safe, but the source\nrepository does not. (default: True)\n" }, { "name": "storage", "content": "Control the strategy Mercurial uses internally to store history. Options in this category im‐\npact performance and repository size.\n" }, { "name": "revlog.issue6528.fix-incoming", "content": "Version 5.8 of Mercurial had a bug leading to altering the parent of file revision\nwith copy information (or any other metadata) on exchange. This leads to the copy\nmetadata to be overlooked by various internal logic. The issue was fixed in Mercurial\n5.8.1. (See https://bz.mercurial-scm.org/showbug.cgi?id=6528 for details)\n\nAs a result Mercurial is now checking and fixing incoming file revisions to make sure\nthere parents are in the right order. This behavior can be disabled by setting this\noption to no. This apply to revisions added through push, pull, clone and unbundle.\n\nTo fix affected revisions that already exist within the repository, one can use hg de‐\nbug-repair-issue-6528.\n" }, { "name": "revlog.delta-parent-search.candidate-group-chunk-size", "content": "Tune the number of delta bases the storage will consider in the same \"round\" of\nsearch. In some very rare cases, using a smaller value might result in faster process‐\ning at the possible expense of storage space, while using larger values might result\nin slower processing at the possible benefit of storage space. A value of \"0\" means no\nlimitation.\n\ndefault: no limitation\n\nThis is unlikely that you'll have to tune this configuration. If you think you do,\nconsider talking with the mercurial developer community about your repositories.\n" }, { "name": "revlog.optimize-delta-parent-choice", "content": "When storing a merge revision, both parents will be equally considered as a possible\ndelta base. This results in better delta selection and improved revlog compression.\nThis option is enabled by default.\n\nTurning this option off can result in large increase of repository size for repository\nwith many merges.\n" }, { "name": "revlog.persistent-nodemap.mmap", "content": "Whether to use the Operating System \"memory mapping\" feature (when possible) to access\nthe persistent nodemap data. This improve performance and reduce memory pressure.\n\nDefault to True.\n\nFor details on the \"persistent-nodemap\" feature, see: hg help config.format.use-per‐\nsistent-nodemap.\n" }, { "name": "revlog.persistent-nodemap.slow-path", "content": "Control the behavior of Merucrial when using a repository with \"persistent\" nodemap\nwith an installation of Mercurial without a fast implementation for the feature:\n\nallow: Silently use the slower implementation to access the repository. warn: Warn,\nbut use the slower implementation to access the repository. abort: Prevent access to\nsuch repositories. (This is the default)\n\nFor details on the \"persistent-nodemap\" feature, see: hg help config.format.use-per‐\nsistent-nodemap.\n" }, { "name": "revlog.reuse-external-delta-parent", "content": "Control the order in which delta parents are considered when adding new revisions from\nan external source. (typically: apply bundle from hg pull or hg push).\n\nNew revisions are usually provided as a delta against other revisions. By default,\nMercurial will try to reuse this delta first, therefore using the same \"delta parent\"\nas the source. Directly using delta's from the source reduces CPU usage and usually\nspeeds up operation. However, in some case, the source might have sub-optimal delta\nbases and forcing their reevaluation is useful. For example, pushes from an old client\ncould have sub-optimal delta's parent that the server want to optimize. (lack of gen‐\neral delta, bad parents, choice, lack of sparse-revlog, etc).\n\nThis option is enabled by default. Turning it off will ensure bad delta parent choices\nfrom older client do not propagate to this repository, at the cost of a small increase\nin CPU consumption.\n\nNote: this option only control the order in which delta parents are considered. Even\nwhen disabled, the existing delta from the source will be reused if the same delta\nparent is selected.\n" }, { "name": "revlog.reuse-external-delta", "content": "Control the reuse of delta from external source. (typically: apply bundle from hg\npull or hg push).\n\nNew revisions are usually provided as a delta against another revision. By default,\nMercurial will not recompute the same delta again, trusting externally provided\ndeltas. There have been rare cases of small adjustment to the diffing algorithm in the\npast. So in some rare case, recomputing delta provided by ancient clients can provides\nbetter results. Disabling this option means going through a full delta recomputation\nfor all incoming revisions. It means a large increase in CPU usage and will slow oper‐\nations down.\n\nThis option is enabled by default. When disabled, it also disables the related stor‐\nage.revlog.reuse-external-delta-parent option.\n" }, { "name": "revlog.zlib.level", "content": "Zlib compression level used when storing data into the repository. Accepted Value\nrange from 1 (lowest compression) to 9 (highest compression). Zlib default value is 6.\n" }, { "name": "revlog.zstd.level", "content": "zstd compression level used when storing data into the repository. Accepted Value\nrange from 1 (lowest compression) to 22 (highest compression). (default 3)\n" }, { "name": "server", "content": "Controls generic server settings.\n" }, { "name": "bookmarks-pushkey-compat", "content": "Trigger pushkey hook when being pushed bookmark updates. This config exist for compat‐\nibility purpose (default to True)\n\nIf you use pushkey and pre-pushkey hooks to control bookmark movement we recommend you\nmigrate them to txnclose-bookmark and pretxnclose-bookmark.\n" }, { "name": "compressionengines", "content": "List of compression engines and their relative priority to advertise to clients.\n\nThe order of compression engines determines their priority, the first having the high‐\nest priority. If a compression engine is not listed here, it won't be advertised to\nclients.\n\nIf not set (the default), built-in defaults are used. Run hg debuginstall to list\navailable compression engines and their default wire protocol priority.\n\nOlder Mercurial clients only support zlib compression and this setting has no effect\nfor legacy clients.\n" }, { "name": "uncompressed", "content": "Whether to allow clients to clone a repository using the uncompressed streaming proto‐\ncol. This transfers about 40% more data than a regular clone, but uses less memory and\nCPU on both server and client. Over a LAN (100 Mbps or better) or a very fast WAN, an\nuncompressed streaming clone is a lot faster (~10x) than a regular clone. Over most\nWAN connections (anything slower than about 6 Mbps), uncompressed streaming is slower,\nbecause of the extra data transfer overhead. This mode will also temporarily hold the\nwrite lock while determining what data to transfer. (default: True)\n" }, { "name": "uncompressedallowsecret", "content": "Whether to allow stream clones when the repository contains secret changesets. (de‐\nfault: False)\n" }, { "name": "preferuncompressed", "content": "When set, clients will try to use the uncompressed streaming protocol. (default:\nFalse)\n" }, { "name": "disablefullbundle", "content": "When set, servers will refuse attempts to do pull-based clones. If this option is\nset, preferuncompressed and/or clone bundles are highly recommended. Partial clones\nwill still be allowed. (default: False)\n" }, { "name": "streamunbundle", "content": "When set, servers will apply data sent from the client directly, otherwise it will be\nwritten to a temporary file first. This option effectively prevents concurrent pushes.\n" }, { "name": "pullbundle", "content": "When set, the server will check pullbundles.manifest for bundles covering the re‐\nquested heads and common nodes. The first matching entry will be streamed to the\nclient.\n\nFor HTTP transport, the stream will still use zlib compression for older clients.\n" }, { "name": "concurrent-push-mode", "content": "Level of allowed race condition between two pushing clients.\n\n• 'strict': push is abort if another client touched the repository while the push was\npreparing.\n\n• 'check-related': push is only aborted if it affects head that got also affected\nwhile the push was preparing. (default since 5.4)\n\n'check-related' only takes effect for compatible clients (version 4.3 and later).\nOlder clients will use 'strict'.\n" }, { "name": "validate", "content": "Whether to validate the completeness of pushed changesets by checking that all new\nfile revisions specified in manifests are present. (default: False)\n" }, { "name": "maxhttpheaderlen", "content": "Instruct HTTP clients not to send request headers longer than this many bytes. (de‐\nfault: 1024)\n" }, { "name": "bundle1", "content": "Whether to allow clients to push and pull using the legacy bundle1 exchange format.\n(default: True)\n" }, { "name": "bundle1gd", "content": "Like bundle1 but only used if the repository is using the generaldelta storage format.\n(default: True)\n" }, { "name": "bundle1.push", "content": "Whether to allow clients to push using the legacy bundle1 exchange format. (default:\nTrue)\n" }, { "name": "bundle1gd.push", "content": "Like bundle1.push but only used if the repository is using the generaldelta storage\nformat. (default: True)\n" }, { "name": "bundle1.pull", "content": "Whether to allow clients to pull using the legacy bundle1 exchange format. (default:\nTrue)\n" }, { "name": "bundle1gd.pull", "content": "Like bundle1.pull but only used if the repository is using the generaldelta storage\nformat. (default: True)\n\nLarge repositories using the generaldelta storage format should consider setting this\noption because converting generaldelta repositories to the exchange format required by\nthe bundle1 data format can consume a lot of CPU.\n" }, { "name": "bundle2.stream", "content": "Whether to allow clients to pull using the bundle2 streaming protocol. (default:\nTrue)\n" }, { "name": "zliblevel", "content": "Integer between -1 and 9 that controls the zlib compression level for wire protocol\ncommands that send zlib compressed output (notably the commands that send repository\nhistory data).\n\nThe default (-1) uses the default zlib compression level, which is likely equivalent\nto 6. 0 means no compression. 9 means maximum compression.\n\nSetting this option allows server operators to make trade-offs between bandwidth and\nCPU used. Lowering the compression lowers CPU utilization but sends more bytes to\nclients.\n\nThis option only impacts the HTTP server.\n" }, { "name": "zstdlevel", "content": "Integer between 1 and 22 that controls the zstd compression level for wire protocol\ncommands. 1 is the minimal amount of compression and 22 is the highest amount of com‐\npression.\n\nThe default (3) should be significantly faster than zlib while likely delivering bet‐\nter compression ratios.\n\nThis option only impacts the HTTP server.\n\nSee also server.zliblevel.\n" }, { "name": "view", "content": "Repository filter used when exchanging revisions with the peer.\n\nThe default view (served) excludes secret and hidden changesets. Another useful value\nis immutable (no draft, secret or hidden changesets). (EXPERIMENTAL)\n" }, { "name": "smtp", "content": "Configuration for extensions that need to send email messages.\n" }, { "name": "host", "content": "Host name of mail server, e.g. \"mail.example.com\".\n" }, { "name": "port", "content": "Optional. Port to connect to on mail server. (default: 465 if tls is smtps; 25 other‐\nwise)\n" }, { "name": "tls", "content": "Optional. Method to enable TLS when connecting to mail server: starttls, smtps or\nnone. (default: none)\n" }, { "name": "username", "content": "Optional. User name for authenticating with the SMTP server. (default: None)\n" }, { "name": "password", "content": "Optional. Password for authenticating with the SMTP server. If not specified, interac‐\ntive sessions will prompt the user for a password; non-interactive sessions will fail.\n(default: None)\n" }, { "name": "local_hostname", "content": "Optional. The hostname that the sender can use to identify itself to the MTA.\n" }, { "name": "subpaths", "content": "Subrepository source URLs can go stale if a remote server changes name or becomes temporarily\nunavailable. This section lets you define rewrite rules of the form:\n\n = \n\nwhere pattern is a regular expression matching a subrepository source URL and replacement is\nthe replacement string used to rewrite it. Groups can be matched in pattern and referenced in\nreplacements. For instance:\n\nhttp://server/(.*)-hg/ = http://hg.server/\\1/\n\nrewrites http://server/foo-hg/ into http://hg.server/foo/.\n\nRelative subrepository paths are first made absolute, and the rewrite rules are then applied\non the full (absolute) path. If pattern doesn't match the full path, an attempt is made to\napply it on the relative path alone. The rules are applied in definition order.\n" }, { "name": "subrepos", "content": "This section contains options that control the behavior of the subrepositories feature. See\nalso hg help subrepos.\n\nSecurity note: auditing in Mercurial is known to be insufficient to prevent clone-time code\nexecution with carefully constructed Git subrepos. It is unknown if a similar detect is\npresent in Subversion subrepos. Both Git and Subversion subrepos are disabled by default out\nof security concerns. These subrepo types can be enabled using the respective options below.\n" }, { "name": "allowed", "content": "Whether subrepositories are allowed in the working directory.\n\nWhen false, commands involving subrepositories (like hg update) will fail for all sub‐\nrepository types. (default: true)\n" }, { "name": "hg:allowed", "content": "Whether Mercurial subrepositories are allowed in the working directory. This option\nonly has an effect if subrepos.allowed is true. (default: true)\n" }, { "name": "git:allowed", "content": "Whether Git subrepositories are allowed in the working directory. This option only\nhas an effect if subrepos.allowed is true.\n\nSee the security note above before enabling Git subrepos. (default: false)\n" }, { "name": "svn:allowed", "content": "Whether Subversion subrepositories are allowed in the working directory. This option\nonly has an effect if subrepos.allowed is true.\n\nSee the security note above before enabling Subversion subrepos. (default: false)\n" }, { "name": "templatealias", "content": "Alias definitions for templates. See hg help templates for details.\n" }, { "name": "templates", "content": "Use the [templates] section to define template strings. See hg help templates for details.\n" }, { "name": "trusted", "content": "Mercurial will not use the settings in the .hg/hgrc file from a repository if it doesn't be‐\nlong to a trusted user or to a trusted group, as various hgrc features allow arbitrary com‐\nmands to be run. This issue is often encountered when configuring hooks or extensions for\nshared repositories or servers. However, the web interface will use some safe settings from\nthe [web] section.\n\nThis section specifies what users and groups are trusted. The current user is always trusted.\nTo trust everybody, list a user or a group with name *. These settings must be placed in an\nalready-trusted file to take effect, such as $HOME/.hgrc of the user or service running Mer‐\ncurial.\n" }, { "name": "users", "content": "Comma-separated list of trusted users.\n" }, { "name": "groups", "content": "Comma-separated list of trusted groups.\n\nui\nUser interface controls.\n" }, { "name": "archivemeta", "content": "Whether to include the .hgarchival.txt file containing meta data (hashes for the\nrepository base and for tip) in archives created by the hg archive command or down‐\nloaded via hgweb. (default: True)\n" }, { "name": "askusername", "content": "Whether to prompt for a username when committing. If True, and neither $HGUSER nor\n$EMAIL has been specified, then the user will be prompted to enter a username. If no\nusername is entered, the default USER@HOST is used instead. (default: False)\n" }, { "name": "clonebundles", "content": "Whether the \"clone bundles\" feature is enabled.\n\nWhen enabled, hg clone may download and apply a server-advertised bundle file from a\nURL instead of using the normal exchange mechanism.\n\nThis can likely result in faster and more reliable clones.\n\n(default: True)\n" }, { "name": "clonebundlefallback", "content": "Whether failure to apply an advertised \"clone bundle\" from a server should result in\nfallback to a regular clone.\n\nThis is disabled by default because servers advertising \"clone bundles\" often do so to\nreduce server load. If advertised bundles start mass failing and clients automatically\nfall back to a regular clone, this would add significant and unexpected load to the\nserver since the server is expecting clone operations to be offloaded to pre-generated\nbundles. Failing fast (the default behavior) ensures clients don't overwhelm the\nserver when \"clone bundle\" application fails.\n\n(default: False)\n" }, { "name": "clonebundleprefers", "content": "Defines preferences for which \"clone bundles\" to use.\n\nServers advertising \"clone bundles\" may advertise multiple available bundles. Each\nbundle may have different attributes, such as the bundle type and compression format.\nThis option is used to prefer a particular bundle over another.\n\nThe following keys are defined by Mercurial:\n\nBUNDLESPEC\nA bundle type specifier. These are strings passed to hg bundle -t. e.g.\ngzip-v2 or bzip2-v1.\n\nCOMPRESSION\nThe compression format of the bundle. e.g. gzip and bzip2.\n\nServer operators may define custom keys.\n\nExample values: COMPRESSION=bzip2, BUNDLESPEC=gzip-v2, COMPRESSION=gzip.\n\nBy default, the first bundle advertised by the server is used.\n" }, { "name": "color", "content": "When to colorize output. Possible value are Boolean (\"yes\" or \"no\"), or \"debug\", or\n\"always\". (default: \"yes\"). \"yes\" will use color whenever it seems possible. See hg\nhelp color for details.\n" }, { "name": "commitsubrepos", "content": "Whether to commit modified subrepositories when committing the parent repository. If\nFalse and one subrepository has uncommitted changes, abort the commit. (default:\nFalse)\n" }, { "name": "debug", "content": "Print debugging information. (default: False)\n" }, { "name": "editor", "content": "The editor to use during a commit. (default: $EDITOR or vi)\n" }, { "name": "fallbackencoding", "content": "Encoding to try if it's not possible to decode the changelog using UTF-8. (default:\nISO-8859-1)\n" }, { "name": "graphnodetemplate", "content": "(DEPRECATED) Use command-templates.graphnode instead.\n" }, { "name": "ignore", "content": "A file to read per-user ignore patterns from. This file should be in the same format\nas a repository-wide .hgignore file. Filenames are relative to the repository root.\nThis option supports hook syntax, so if you want to specify multiple ignore files, you\ncan do so by setting something like ignore.other = ~/.hgignore2. For details of the\nignore file format, see the hgignore(5) man page.\n" }, { "name": "interactive", "content": "Allow to prompt the user. (default: True)\n" }, { "name": "interface", "content": "Select the default interface for interactive features (default: text). Possible val‐\nues are 'text' and 'curses'.\n" }, { "name": "interface.chunkselector", "content": "Select the interface for change recording (e.g. hg commit -i). Possible values are\n'text' and 'curses'. This config overrides the interface specified by ui.interface.\n" }, { "name": "large-file-limit", "content": "Largest file size that gives no memory use warning. Possible values are integers or 0\nto disable the check. Value is expressed in bytes by default, one can use standard\nunits for convenience (e.g. 10MB, 0.1GB, etc) (default: 10MB)\n" }, { "name": "logtemplate", "content": "(DEPRECATED) Use command-templates.log instead.\n" }, { "name": "merge", "content": "The conflict resolution program to use during a manual merge. For more information on\nmerge tools see hg help merge-tools. For configuring merge tools see the\n[merge-tools] section.\n" }, { "name": "mergemarkers", "content": "Sets the merge conflict marker label styling. The detailed style uses the command-tem‐\nplates.mergemarker setting to style the labels. The basic style just uses 'local' and\n'other' as the marker label. One of basic or detailed. (default: basic)\n" }, { "name": "mergemarkertemplate", "content": "(DEPRECATED) Use command-templates.mergemarker instead.\n" }, { "name": "message-output", "content": "Where to write status and error messages. (default: stdio)\n\nchannel\n\nUse separate channel for structured output. (Command-server only)\n\nstderr\n\nEverything to stderr.\n\nstdio\n\nStatus to stdout, and error to stderr.\n" }, { "name": "origbackuppath", "content": "The path to a directory used to store generated .orig files. If the path is not a di‐\nrectory, one will be created. If set, files stored in this directory have the same\nname as the original file and do not have a .orig suffix.\n" }, { "name": "paginate", "content": "Control the pagination of command output (default: True). See hg help pager for de‐\ntails.\n" }, { "name": "patch", "content": "An optional external tool that hg import and some extensions will use for applying\npatches. By default Mercurial uses an internal patch utility. The external tool must\nwork as the common Unix patch program. In particular, it must accept a -p argument to\nstrip patch headers, a -d argument to specify the current directory, a file name to\npatch, and a patch file to take from stdin.\n\nIt is possible to specify a patch tool together with extra arguments. For example,\nsetting this option to patch --merge will use the patch program with its 2-way merge\noption.\n" }, { "name": "portablefilenames", "content": "Check for portable filenames. Can be warn, ignore or abort. (default: warn)\n\nwarn\n\nPrint a warning message on POSIX platforms, if a file with a non-portable file‐\nname is added (e.g. a file with a name that can't be created on Windows because\nit contains reserved parts like AUX, reserved characters like :, or would cause\na case collision with an existing file).\n\nignore\n\nDon't print a warning.\n\nabort\n\nThe command is aborted.\n\ntrue\n\nAlias for warn.\n\nfalse\n\nAlias for ignore.\n\nOn Windows, this configuration option is ignored and the command aborted.\n" }, { "name": "pre-merge-tool-output-template", "content": "(DEPRECATED) Use command-template.pre-merge-tool-output instead.\n" }, { "name": "quiet", "content": "Reduce the amount of output printed. (default: False)\n" }, { "name": "relative-paths", "content": "Prefer relative paths in the UI.\n" }, { "name": "remotecmd", "content": "Remote command to use for clone/push/pull operations. (default: hg)\n" }, { "name": "report_untrusted", "content": "Warn if a .hg/hgrc file is ignored due to not being owned by a trusted user or group.\n(default: True)\n" }, { "name": "slash", "content": "(Deprecated. Use slashpath template filter instead.)\n\nDisplay paths using a slash (/) as the path separator. This only makes a difference on\nsystems where the default path separator is not the slash character (e.g. Windows uses\nthe backslash character (\\)). (default: False)\n" }, { "name": "statuscopies", "content": "Display copies in the status command.\n" }, { "name": "ssh", "content": "Command to use for SSH connections. (default: ssh)\n" }, { "name": "ssherrorhint", "content": "A hint shown to the user in the case of SSH error (e.g. Please see http://company/in‐\nternalwiki/ssh.html)\n" }, { "name": "strict", "content": "Require exact command names, instead of allowing unambiguous abbreviations. (default:\nFalse)\n" }, { "name": "style", "content": "Name of style to use for command output.\n" }, { "name": "supportcontact", "content": "A URL where users should report a Mercurial traceback. Use this if you are a large or‐\nganisation with its own Mercurial deployment process and crash reports should be ad‐\ndressed to your internal support.\n" }, { "name": "textwidth", "content": "Maximum width of help text. A longer line generated by hg help or hg subcommand --help\nwill be broken after white space to get this width or the terminal width, whichever\ncomes first. A non-positive value will disable this and the terminal width will be\nused. (default: 78)\n" }, { "name": "timeout", "content": "The timeout used when a lock is held (in seconds), a negative value means no timeout.\n(default: 600)\n" }, { "name": "timeout.warn", "content": "Time (in seconds) before a warning is printed about held lock. A negative value means\nno warning. (default: 0)\n" }, { "name": "traceback", "content": "Mercurial always prints a traceback when an unknown exception occurs. Setting this to\nTrue will make Mercurial print a traceback on all exceptions, even those recognized by\nMercurial (such as IOError or MemoryError). (default: False)\n" }, { "name": "tweakdefaults", "content": "By default Mercurial's behavior changes very little from release to release, but over time\nthe recommended config settings shift. Enable this config to opt in to get automatic\ntweaks to Mercurial's behavior over time. This config setting will have no effect if HG‐\nPLAIN is set or HGPLAINEXCEPT is set and does not include tweakdefaults. (default: False)\n\nIt currently means:\n\n[ui]\n# The rollback command is dangerous. As a rule, don't use it.\nrollback = False\n# Make `hg status` report copy information\nstatuscopies = yes\n# Prefer curses UIs when available. Revert to plain-text with `text`.\ninterface = curses\n# Make compatible commands emit cwd-relative paths by default.\nrelative-paths = yes\n\n[commands]\n# Grep working directory by default.\ngrep.all-files = True\n# Refuse to perform an `hg update` that would cause a file content merge\nupdate.check = noconflict\n# Show conflicts information in `hg status`\nstatus.verbose = True\n# Make `hg resolve` with no action (like `-m`) fail instead of re-merging.\nresolve.explicit-re-merge = True\n\n[diff]\ngit = 1\nshowfunc = 1\nword-diff = 1\n" }, { "name": "username", "content": "The committer of a changeset created when running \"commit\". Typically a person's name\nand email address, e.g. Fred Widget . Environment variables in the\nusername are expanded.\n\n(default: $EMAIL or username@hostname. If the username in hgrc is empty, e.g. if the\nsystem admin set username = in the system hgrc, it has to be specified manually or in\na different hgrc file)\n" }, { "name": "verbose", "content": "Increase the amount of output printed. (default: False)\n" }, { "name": "usage", "content": "" }, { "name": "repository-role", "content": "What this repository is used for.\n\nThis is used to adjust behavior and performance to best fit the repository purpose.\n\nCurrently recognised values are:\n\n• default: an all purpose repository\n" }, { "name": "resources", "content": "How aggressive Mercurial can be with resource usage:\n\nCurrently recognised values are:\n\n• default: the default value currently is equivalent to medium,\n\n• high: allows for higher cpu, memory and disk-space usage to improve performance of\nsome operations.\n\n• medium: aims at a moderate resource usage,\n\n• low: reduces resources usage when possible, decreasing overall performance.\n\nFor finer configuration, see also usage.resources.cpu, usage.resources.disk and us‐\nage.resources.memory.\n" }, { "name": "resources.cpu", "content": "How aggressive Mercurial can be in terms of cpu usage:\n\nCurrently recognised values are:\n\n• default: the default value, inherits the value from usage.resources,\n\n• high: allows for more aggressive cpu usage, improving storage quality and the per‐\nformance of some operations at the expense of machine load\n\n• medium: aims at a moderate cpu usage,\n\n• low: reduces cpu usage when possible, potentially at the expense of slower opera‐\ntions, increased storage and exchange payload.\n" }, { "name": "resources.disk", "content": "How aggressive Mercurial can be in terms of disk usage:\n\nCurrently recognised values are:: - default: the default value, inherits the value\nfrom usage.resources,\n\n• high: allows for more disk space usage where it can improve performance,\n\n• medium: aims at a moderate disk usage,\n\n• low: reduces disk usage when possible, decreasing performance in some occasion.\n" }, { "name": "resources.memory", "content": "How aggressive Mercurial can be in terms of memory usage:\n\nCurrently recognised values are:\n\n- ``default``: the default value, inherits the value from `usage.resources`,\n\n• high: allows for more aggressive memory usage to improve overall performance,\n\n• medium: aims at a moderate memory usage,\n\n• low: reduces memory usage when possible at the cost of overall performance.\n" }, { "name": "command-templates", "content": "Templates used for customizing the output of commands.\n" }, { "name": "graphnode", "content": "The template used to print changeset nodes in an ASCII revision graph. (default:\n{graphnode})\n" }, { "name": "log", "content": "Template string for commands that print changesets.\n" }, { "name": "mergemarker", "content": "The template used to print the commit description next to each conflict marker during\nmerge conflicts. See hg help templates for the template format.\n\nDefaults to showing the hash, tags, branches, bookmarks, author, and the first line of\nthe commit description.\n\nIf you use non-ASCII characters in names for tags, branches, bookmarks, authors,\nand/or commit descriptions, you must pay attention to encodings of managed files. At\ntemplate expansion, non-ASCII characters use the encoding specified by the --encoding\nglobal option, HGENCODING or other environment variables that govern your locale. If\nthe encoding of the merge markers is different from the encoding of the merged files,\nserious problems may occur.\n\nCan be overridden per-merge-tool, see the [merge-tools] section.\n" }, { "name": "oneline-summary", "content": "A template used by hg rebase and other commands for showing a one-line summary of a\ncommit. If the template configured here is longer than one line, then only the first\nline is used.\n\nThe template can be overridden per command by defining a template in oneline-sum‐\nmary., where can be e.g. \"rebase\".\n" }, { "name": "pre-merge-tool-output", "content": "A template that is printed before executing an external merge tool. This can be used\nto print out additional context that might be useful to have during the conflict reso‐\nlution, such as the description of the various commits involved or bookmarks/tags.\n\nAdditional information is available in the local`, ``base, and other dicts. For exam‐\nple: {local.label}, {base.name}, or {other.islink}.\n" }, { "name": "web", "content": "Web interface configuration. The settings in this section apply to both the builtin webserver\n(started by hg serve) and the script you run through a webserver (hgweb.cgi and the deriva‐\ntives for FastCGI and WSGI).\n\nThe Mercurial webserver does no authentication (it does not prompt for usernames and pass‐\nwords to validate who users are), but it does do authorization (it grants or denies access\nfor authenticated users based on settings in this section). You must either configure your\nwebserver to do authentication for you, or disable the authorization checks.\n\nFor a quick setup in a trusted environment, e.g., a private LAN, where you want it to accept\npushes from anybody, you can use the following command line:\n\n$ hg --config web.allow-push=* --config web.pushssl=False serve\n\nNote that this will allow anybody to push anything to the server and that this should not be\nused for public servers.\n\nThe full set of options is:\n" }, { "name": "accesslog", "content": "Where to output the access log. (default: stdout)\n" }, { "name": "address", "content": "Interface address to bind to. (default: all)\n" }, { "name": "allow-archive", "content": "List of archive format (bz2, gz, zip) allowed for downloading. (default: empty)\n" }, { "name": "allowbz2", "content": "(DEPRECATED) Whether to allow .tar.bz2 downloading of repository revisions. (default:\nFalse)\n" }, { "name": "allowgz", "content": "(DEPRECATED) Whether to allow .tar.gz downloading of repository revisions. (default:\nFalse)\n" }, { "name": "allow-pull", "content": "Whether to allow pulling from the repository. (default: True)\n" }, { "name": "allow-push", "content": "Whether to allow pushing to the repository. If empty or not set, pushing is not al‐\nlowed. If the special value *, any remote user can push, including unauthenticated\nusers. Otherwise, the remote user must have been authenticated, and the authenticated\nuser name must be present in this list. The contents of the allow-push list are exam‐\nined after the denypush list.\n" }, { "name": "allow_read", "content": "If the user has not already been denied repository access due to the contents of\ndenyread, this list determines whether to grant repository access to the user. If\nthis list is not empty, and the user is unauthenticated or not present in the list,\nthen access is denied for the user. If the list is empty or not set, then access is\npermitted to all users by default. Setting allowread to the special value * is equiv‐\nalent to it not being set (i.e. access is permitted to all users). The contents of the\nallowread list are examined after the denyread list.\n" }, { "name": "allowzip", "content": "(DEPRECATED) Whether to allow .zip downloading of repository revisions. This feature\ncreates temporary files. (default: False)\n" }, { "name": "archivesubrepos", "content": "Whether to recurse into subrepositories when archiving. (default: False)\n" }, { "name": "baseurl", "content": "Base URL to use when publishing URLs in other locations, so third-party tools like\nemail notification hooks can construct URLs. Example: http://hgserver/repos/.\n" }, { "name": "cacerts", "content": "Path to file containing a list of PEM encoded certificate authority certificates. En‐\nvironment variables and ~user constructs are expanded in the filename. If specified on\nthe client, then it will verify the identity of remote HTTPS servers with these cer‐\ntificates.\n\nTo disable SSL verification temporarily, specify --insecure from command line.\n\nYou can use OpenSSL's CA certificate file if your platform has one. On most Linux sys‐\ntems this will be /etc/ssl/certs/ca-certificates.crt. Otherwise you will have to gen‐\nerate this file manually. The form must be as follows:\n\n-----BEGIN CERTIFICATE-----\n... (certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n... (certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n" }, { "name": "cache", "content": "Whether to support caching in hgweb. (default: True)\n" }, { "name": "certificate", "content": "Certificate to use when running hg serve.\n" }, { "name": "collapse", "content": "With descend enabled, repositories in subdirectories are shown at a single level\nalongside repositories in the current path. With collapse also enabled, repositories\nresiding at a deeper level than the current path are grouped behind navigable direc‐\ntory entries that lead to the locations of these repositories. In effect, this setting\ncollapses each collection of repositories found within a subdirectory into a single\nentry for that subdirectory. (default: False)\n" }, { "name": "comparisoncontext", "content": "Number of lines of context to show in side-by-side file comparison. If negative or the\nvalue full, whole files are shown. (default: 5)\n\nThis setting can be overridden by a context request parameter to the comparison com‐\nmand, taking the same values.\n" }, { "name": "contact", "content": "Name or email address of the person in charge of the repository. (default: ui.user‐\nname or $EMAIL or \"unknown\" if unset or empty)\n" }, { "name": "csp", "content": "Send a Content-Security-Policy HTTP header with this value.\n\nThe value may contain a special string %nonce%, which will be replaced by a ran‐\ndomly-generated one-time use value. If the value contains %nonce%, web.cache will be\ndisabled, as caching undermines the one-time property of the nonce. This nonce will\nalso be inserted into