Mercurial > hg
comparison mercurial/help/hgweb.txt @ 24079:afe03a616525
help.hgweb: add a section describing URLs and common parameters
The behavior of hgweb's URLs isn't documented anywhere inside Mercurial.
Let's start to change that.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Fri, 06 Feb 2015 23:08:47 -0800 |
parents | e7cfe3587ea4 |
children | a3f2ea1d4943 |
comparison
equal
deleted
inserted
replaced
24078:e44586d9c207 | 24079:afe03a616525 |
---|---|
46 - The fourth entry will publish both ``http://server/user/bob/quux/`` | 46 - The fourth entry will publish both ``http://server/user/bob/quux/`` |
47 and ``http://server/user/bob/quux/testsubrepo/`` | 47 and ``http://server/user/bob/quux/testsubrepo/`` |
48 | 48 |
49 The ``collections`` section is deprecated and has been superseded by | 49 The ``collections`` section is deprecated and has been superseded by |
50 ``paths``. | 50 ``paths``. |
51 | |
52 URLs and Common Arguments | |
53 ========================= | |
54 | |
55 URLs under each repository have the form ``/{command}[/{arguments}]`` | |
56 where ``{command}`` represents the name of a command or handler and | |
57 ``{arguments}`` represents any number of additional URL parameters | |
58 to that command. | |
59 | |
60 The web server has a default style associated with it. Styles map to | |
61 a collection of named templates. Each template is used to render a | |
62 specific piece of data, such as a changeset or diff. | |
63 | |
64 The style for the current request can be overwritten two ways. First, | |
65 if ``{command}`` contains a hyphen (``-``), the text before the hyphen | |
66 defines the style. For example, ``/atom-log`` will render the ``log`` | |
67 command handler with the ``atom`` style. The second way to set the | |
68 style is with the ``style`` query string argument. For example, | |
69 ``/log?style=atom``. The hyphenated URL parameter is preferred. | |
70 | |
71 Not all templates are available for all styles. Attempting to use | |
72 a style that doesn't have all templates defined may result in an error | |
73 rendering the page. | |
74 | |
75 Many commands take a ``{revision}`` URL parameter. This defines the | |
76 changeset to operate on. This is commonly specified as the short, | |
77 12 digit hexidecimal abbreviation for the full 40 character unique | |
78 revision identifier. However, any value described by | |
79 :hg:`help revisions` typically works. |