webcommands: document "manifest" web command
authorGregory Szorc <gregory.szorc@gmail.com>
Fri, 06 Feb 2015 21:48:01 -0800
changeset 24090 a86b2922ea30
parent 24089 f17773432782
child 24091 6b6ec887c79b
webcommands: document "manifest" web command
mercurial/hgweb/webcommands.py
--- a/mercurial/hgweb/webcommands.py	Fri Feb 06 21:39:15 2015 -0800
+++ b/mercurial/hgweb/webcommands.py	Fri Feb 06 21:48:01 2015 -0800
@@ -494,6 +494,21 @@
 
 @webcommand('manifest')
 def manifest(web, req, tmpl):
+    """
+    /manifest[/{revision}[/{path}]]
+    -------------------------------
+
+    Show information about a directory.
+
+    If the URL path arguments are defined, information about the root
+    directory for the ``tip`` changeset will be shown.
+
+    Because this handler can only show information for directories, it
+    is recommended to use the ``file`` handler instead, as it can handle both
+    directories and files.
+
+    The ``manifest`` template will be rendered for this handler.
+    """
     ctx = webutil.changectx(web.repo, req)
     path = webutil.cleanpath(web.repo, req.form.get('file', [''])[0])
     mf = ctx.manifest()