Mercurial > hg
changeset 46905:95a5ed7db9ca
help: document the `path://` url scheme
If we want people to use it, we need to document it.
Differential Revision: https://phab.mercurial-scm.org/D10372
author | Pierre-Yves David <pierre-yves.david@octobus.net> |
---|---|
date | Sat, 10 Apr 2021 15:30:32 +0200 |
parents | ede52e19c752 |
children | 33524c46a092 |
files | mercurial/helptext/config.txt mercurial/helptext/urls.txt tests/test-help.t |
diffstat | 3 files changed, 16 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/helptext/config.txt Sat Apr 10 15:28:10 2021 +0200 +++ b/mercurial/helptext/config.txt Sat Apr 10 15:30:32 2021 +0200 @@ -1712,6 +1712,9 @@ my_server = https://example.com/my_path my_server:pushurl = ssh://example.com/my_path +Paths using the `path://otherpath` scheme will inherit the sub-options value from +the path they point to. + The following sub-options can be defined: ``pushurl``
--- a/mercurial/helptext/urls.txt Sat Apr 10 15:28:10 2021 +0200 +++ b/mercurial/helptext/urls.txt Sat Apr 10 15:30:32 2021 +0200 @@ -5,6 +5,7 @@ http://[user[:pass]@]host[:port]/[path][#revision] https://[user[:pass]@]host[:port]/[path][#revision] ssh://[user@]host[:port]/[path][#revision] + path://pathname Paths in the local filesystem can either point to Mercurial repositories or to bundle files (as created by :hg:`bundle` or @@ -64,3 +65,12 @@ default-push: The push command will look for a path named 'default-push', and prefer it over 'default' if both are defined. + +These alias can also be use in the `path://` scheme:: + + [paths] + alias1 = URL1 + alias2 = path://alias1 + ... + +check :hg:`help config.paths` for details about the behavior of such "sub-path".
--- a/tests/test-help.t Sat Apr 10 15:28:10 2021 +0200 +++ b/tests/test-help.t Sat Apr 10 15:30:32 2021 +0200 @@ -1842,6 +1842,9 @@ my_server = https://example.com/my_path my_server:pushurl = ssh://example.com/my_path + Paths using the 'path://otherpath' scheme will inherit the sub-options + value from the path they point to. + The following sub-options can be defined: "pushurl"