# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 2021-04-10 13:30:32
# Node ID 95a5ed7db9cabe52bcf84599e017ec1bed63a290
# Parent  ede52e19c752eeff69d4df8188413b0111a62f04

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

diff --git a/mercurial/helptext/config.txt b/mercurial/helptext/config.txt
--- a/mercurial/helptext/config.txt
+++ b/mercurial/helptext/config.txt
@@ -1712,6 +1712,9 @@ behavior for that specific path. Example
     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 @@ Valid URLs are of the form::
   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:
 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/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -1842,6 +1842,9 @@ Test section lookup
         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"