[PATCH 1 of 1] help: improve hgweb help

[Mads Kiilerich]

# HG changeset patch
# User Mads Kiilerich <mads at kiilerich.com>
# Date 1340236931 -7200
# Node ID e71561ec21d8b34fc0d2ef883fe58582ac3d3e67
# Parent  468a950aebc30da58abd968ca2ca76bfddd97bc4
help: improve hgweb help

The existing help only walked through an example.

Now we first explain the basic rules and then show an example.

The 'collections' example and description only cause confusion and is removed.

diff --git a/mercurial/help/hgweb.txt b/mercurial/help/hgweb.txt
--- a/mercurial/help/hgweb.txt
+++ b/mercurial/help/hgweb.txt
@@ -1,7 +1,8 @@
 Mercurial's internal web server, hgweb, can serve either a single
-repository, or a collection of them. In the latter case, a special
+repository, or a tree of them. In the latter case, a special
 configuration file can be used to specify the repository paths to use
-and global web configuration options.
+and global web configuration options. The same configuration file can be used
+by :hg:`serve`, ``hgweb.wsgi``, ``hgweb.cgi`` and ``hgweb.fcgi``.
 
 This file uses the same syntax as other Mercurial configuration files,
 but only the following sections are recognized:
@@ -14,34 +15,38 @@
 section of the hgrc(5) documentation. See :hg:`help config` for
 information on where to find the manual page.
 
-The ``paths`` section provides mappings of physical repository
-paths to virtual ones. For instance::
+The ``paths`` section provides mappings from URL paths to internal filesystem
+paths of repositories. hgweb will not expose the filesystem directly - only
+Mercurial repositories can be published and only according to the
+configuration.
+
+The left hand side is the path in the URL. Note that some paths below
+repositories already are used by hgweb - for instance ``rev`` and ``file``.
+
+The right hand side is the path in the file system. If the specified path ends
+in ``*`` or ``**`` the filesystem will be searched recursively for repositories
+below that point.
+With ``*`` it will not recurse into the repositories it finds (except for
+``.hg/patches``).
+With ``**`` it will also search inside repository working directories and will
+thus find repositories that are used as subrepos.
+
+For instance::
 
   [paths]
-  projects/a = /foo/bar
-  projects/b = /baz/quux
-  web/root = /real/root/*
-  / = /real/root2/*
-  virtual/root2 = /real/root2/**
+  /projects/a = /srv/tmprepos/a
+  /projects/b = c:/repos/b
+  / = /srv/repos/*
+  /user/bob = /home/bob/repos/**
 
 - The first two entries make two repositories in different directories
   appear under the same directory in the web interface
-- The third entry maps every Mercurial repository found in '/real/root'
-  into 'web/root'. This format is preferred over the [collections] one,
-  since using absolute paths as configuration keys is not supported on every
-  platform (especially on Windows).
-- The fourth entry is a special case mapping all repositories in
-  '/real/root2' in the root of the virtual directory.
-- The fifth entry recursively finds all repositories under the real
-  root, and maps their relative paths under the virtual root.
+- The third entry will publish every Mercurial repository found in
+  ``/srv/repos/``, for instance the repository ``/srv/repos/quux/`` as
+  ``http://server/quux/``
+- The fourth entry will publish for instance both
+  ``http://server/user/bob/quux/`` and
+  ``http://server/user/bob/quux/testsubrepo/``
 
-The ``collections`` section provides mappings of trees of physical
-repositories paths to virtual ones, though the paths syntax is generally
-preferred. For instance::
-
-  [collections]
-  /foo = /foo
-
-Here, the left side will be stripped off all repositories found in the
-right side. Thus ``/foo/bar`` and ``foo/quux/baz`` will be listed as
-``bar`` and ``quux/baz`` respectively.
+The ``collections`` section is deprecated and has been superseeded by
+``paths``.
diff --git a/mercurial/hgweb/hgwebdir_mod.py b/mercurial/hgweb/hgwebdir_mod.py
--- a/mercurial/hgweb/hgwebdir_mod.py
+++ b/mercurial/hgweb/hgwebdir_mod.py
@@ -23,10 +23,10 @@
     repos = []
     for prefix, root in cleannames(paths):
         roothead, roottail = os.path.split(root)
-        # "foo = /bar/*" makes every subrepo of /bar/ to be
-        # mounted as foo/subrepo
-        # and "foo = /bar/**" also recurses into the subdirectories,
-        # remember to use it without working dir.
+        # "foo = /bar/*" or "foo = /bar/**" lets every repo /bar/N in or below
+        # /bar/ be served as as foo/N .
+        # '*' will not search inside dirs with .hg (except .hg/patches),
+        # '**' will search inside dirs with .hg (and thus also find subrepos).
         try:
             recurse = {'*': False, '**': True}[roottail]
         except KeyError:
diff --git a/mercurial/scmutil.py b/mercurial/scmutil.py
--- a/mercurial/scmutil.py
+++ b/mercurial/scmutil.py
@@ -352,7 +352,8 @@
         raise util.Abort('%s not under root' % myname)
 
 def walkrepos(path, followsym=False, seen_dirs=None, recurse=False):
-    '''yield every hg repository under path, recursively.'''
+    '''yield every hg repository under path, always recursively.
+    The recurse flag will only control recursion into repo working dirs'''
     def errhandler(err):
         if err.filename == path:
             raise err