Patchwork D10372: help: document the `path://` url scheme

login
register
mail settings
Submitter phabricator
Date April 12, 2021, 3:30 p.m.
Message ID <differential-rev-PHID-DREV-mln56evrxkw6xd3wqpqw-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/48689/
State Superseded
Headers show

Comments

phabricator - April 12, 2021, 3:30 p.m.
marmoute created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  If we want people to use it, we need to document it.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D10372

AFFECTED FILES
  mercurial/helptext/config.txt
  mercurial/helptext/urls.txt
  tests/test-help.t

CHANGE DETAILS




To: marmoute, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -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"
diff --git a/mercurial/helptext/urls.txt b/mercurial/helptext/urls.txt
--- a/mercurial/helptext/urls.txt
+++ b/mercurial/helptext/urls.txt
@@ -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".
diff --git a/mercurial/helptext/config.txt b/mercurial/helptext/config.txt
--- a/mercurial/helptext/config.txt
+++ b/mercurial/helptext/config.txt
@@ -1711,6 +1711,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``