This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7936

help: minor copy editing to the `config.format` section
ClosedPublic

Authored by mharbison72 on Jan 17 2020, 9:28 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG6ae32c12b578: help: minor copy editing to the `config.format` section

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

mharbison72 created this revision.Jan 17 2020, 9:28 PM
pulkit accepted this revision.Jan 20 2020, 7:35 AM
This revision is now accepted and ready to land.Jan 20 2020, 7:35 AM

Revision Contents
Changeset List

PathPackages
Mmercurial/helptext/config.txt (26 lines)

Diff 19455

mercurial/helptext/config.txt

# (this extension will get loaded from the file specified) # (this extension will get loaded from the file specified)
myfeature = ~/.hgext/myfeature.py myfeature = ~/.hgext/myfeature.py
``format`` ``format``
---------- ----------
Configuration that controls the repository format. Newer format options are more Configuration that controls the repository format. Newer format options are more
powerful but incompatible with some older versions of Mercurial. Format options powerful, but incompatible with some older versions of Mercurial. Format options
are considered at repository initialization only. You need to make a new clone are considered at repository initialization only. You need to make a new clone
for config change to be taken into account. for config changes to be taken into account.
For more details about repository format and version compatibility, see For more details about repository format and version compatibility, see
https://www.mercurial-scm.org/wiki/MissingRequirement https://www.mercurial-scm.org/wiki/MissingRequirement
``usegeneraldelta`` ``usegeneraldelta``
Enable or disable the "generaldelta" repository format which improves Enable or disable the "generaldelta" repository format which improves
repository compression by allowing "revlog" to store delta against arbitrary repository compression by allowing "revlog" to store deltas against
revision instead of the previous stored one. This provides significant arbitrary revisions instead of the previously stored one. This provides
improvement for repositories with branches. significant improvement for repositories with branches.
Repositories with this on-disk format require Mercurial version 1.9. Repositories with this on-disk format require Mercurial version 1.9.
Enabled by default. Enabled by default.
``dotencode`` ``dotencode``
Enable or disable the "dotencode" repository format which enhances Enable or disable the "dotencode" repository format which enhances
the "fncache" repository format (which has to be enabled to use the "fncache" repository format (which has to be enabled to use
dotencode) to avoid issues with filenames starting with ._ on dotencode) to avoid issues with filenames starting with "._" on
Mac OS X and spaces on Windows. Mac OS X and spaces on Windows.
Repositories with this on-disk format require Mercurial version 1.7. Repositories with this on-disk format require Mercurial version 1.7.
Enabled by default. Enabled by default.
``usefncache`` ``usefncache``
Enable or disable the "fncache" repository format which enhances Enable or disable the "fncache" repository format which enhances
smaller store. For repositories with many revisions, it also helps smaller store. For repositories with many revisions, it also helps
performance (by using shortened delta chains.) performance (by using shortened delta chains.)
Repositories with this on-disk format require Mercurial version 4.7 Repositories with this on-disk format require Mercurial version 4.7
Enabled by default. Enabled by default.
``revlog-compression`` ``revlog-compression``
Compression algorithm used by revlog. Supported value are `zlib` and `zstd`. Compression algorithm used by revlog. Supported values are `zlib` and
The `zlib` engine is the historical default of Mercurial. `zstd` is a newer `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
format that is usually a net win over `zlib` operating faster at better a newer format that is usually a net win over `zlib`, operating faster at
compression rate. Use `zstd` to reduce CPU usage. better compression rates. Use `zstd` to reduce CPU usage.
On some system, Mercurial installation may lack `zstd` supports. Default is `zlib`. On some systems, the Mercurial installation may lack `zstd` support.
Default is `zlib`.
``bookmarks-in-store`` ``bookmarks-in-store``
Store bookmarks in .hg/store/. This means that bookmarks are shared when Store bookmarks in .hg/store/. This means that bookmarks are shared when
using `hg share` regardless of the `-B` option. using `hg share` regardless of the `-B` option.
Repositories with this on-disk format require Mercurial version 5.1. Repositories with this on-disk format require Mercurial version 5.1.
Disabled by default. Disabled by default.