# HG changeset patch # User Gregory Szorc # Date 1423286813 28800 # Node ID fe3ee31b039ffb26a38b40d5e9a571015e568d59 # Parent 6f5b4393590c5726eadfdfd9e45886332a8008b2 webcommands: document "file" web command diff -r 6f5b4393590c -r fe3ee31b039f mercurial/hgweb/webcommands.py --- a/mercurial/hgweb/webcommands.py Fri Feb 06 21:13:03 2015 -0800 +++ b/mercurial/hgweb/webcommands.py Fri Feb 06 21:26:53 2015 -0800 @@ -131,6 +131,24 @@ @webcommand('file') def file(web, req, tmpl): + """ + /file/{revision}[/{path}] + ------------------------- + + Show information about a directory or file in the repository. + + Info about the ``path`` given as a URL parameter will be rendered. + + If ``path`` is a directory, information about the entries in that + directory will be rendered. This form is equivalent to the ``manifest`` + handler. + + If ``path`` is a file, information about that file will be shown via + the ``filerevision`` template. + + If ``path`` is not defined, information about the root directory will + be rendered. + """ path = webutil.cleanpath(web.repo, req.form.get('file', [''])[0]) if not path: return manifest(web, req, tmpl)