Mercurial Mercurial > mercurial / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
config: document the purpose of the `format` config section
authorBoris Feld <boris.feld@octobus.net>
Thu, 19 Jul 2018 09:57:42 +0200
changeset 38735 8891dc15b327
parent 38734 25880ddf9a86
child 38736 93777d16a25d
config: document the purpose of the `format` config section The config section now have a top level documentation to clarify its intend and usage. In particular, user are now explain when the option are taken in account and how to convert repository. There are an handful of experimental options in this section that does not match its definition. They should be relocated to other section before getting out of experimental. (see next changeset for one example).
mercurial/help/config.txt file | annotate | diff | comparison | revisions 
--- a/mercurial/help/config.txt	Wed Jul 18 18:36:39 2018 -0700
+++ b/mercurial/help/config.txt	Thu Jul 19 09:57:42 2018 +0200
@@ -790,6 +790,14 @@
 ``format``
 ----------
 
+Configuration that controls the repository format. Newer format options are more
+powerful but incompatible with some older versions of Mercurial. Format options
+are considered at repository initialization only. You need to make a new clone
+for config change to be taken into account.
+
+For more details about repository format and version compatibility, see
+https://www.mercurial-scm.org/wiki/MissingRequirement
+
 ``usegeneraldelta``
     Enable or disable the "generaldelta" repository format which improves
     repository compression by allowing "revlog" to store delta against arbitrary
mercurial