Patchwork [04,of,22,hgweb-help] help.hgweb: add a section describing URLs and common parameters

login
register
mail settings
Submitter Gregory Szorc
Date Feb. 7, 2015, 7:15 a.m.
Message ID <f47fcc745ca8295cd06a.1423293342@gps-mbp.local>
Download mbox | patch
Permalink /patch/7742/
State Accepted
Headers show

Comments

Gregory Szorc - Feb. 7, 2015, 7:15 a.m.
# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 1423292927 28800
#      Fri Feb 06 23:08:47 2015 -0800
# Node ID f47fcc745ca8295cd06a3705089452073c3a2877
# Parent  186cd0c34a7ae2c02a608445aaaa95e92f224ada
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.
Gregory Szorc - Feb. 7, 2015, 7:18 a.m.
It appears I can't resolve conflicts properly :/

I'll spare everyone a resend.

On Fri, Feb 6, 2015 at 11:15 PM, Gregory Szorc <gregory.szorc@gmail.com>
wrote:

> # HG changeset patch
> # User Gregory Szorc <gregory.szorc@gmail.com>
> # Date 1423292927 28800
> #      Fri Feb 06 23:08:47 2015 -0800
> # Node ID f47fcc745ca8295cd06a3705089452073c3a2877
> # Parent  186cd0c34a7ae2c02a608445aaaa95e92f224ada
> 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.
>
> diff --git a/mercurial/help/hgweb.txt b/mercurial/help/hgweb.txt
> --- a/mercurial/help/hgweb.txt
> +++ b/mercurial/help/hgweb.txt
> @@ -47,4 +47,43 @@ In this example::
>    and ``http://server/user/bob/quux/testsubrepo/``
>
>  The ``collections`` section is deprecated and has been superseded by
>  ``paths``.
> +<<<<<<< local
> +||||||| base
> +
> +Web Commands / URLs
> +===================
> +
> +The following web commands / URL handlers are registered:
> +
> +  .. webcommandsmarker
> +=======
> +
> +URLs and Common Arguments
> +=========================
> +
> +URLs under each repository have the form ``/{command}[/{arguments}]``
> +where ``{command}`` represents the name of a command or handler and
> +``{arguments}`` represents any number of additional URL parameters
> +to that command.
> +
> +The web server has a default style associated with it. Styles map to
> +a collection of named templates. Each template is used to render a
> +specific piece of data, such as a changeset or diff.
> +
> +The style for the current request can be overwritten two ways. First,
> +if ``{command}`` contains a hyphen (``-``), the text before the hyphen
> +defines the style. For example, ``/atom-log`` will render the ``log``
> +command handler with the ``atom`` style. The second way to set the
> +style is with the ``style`` query string argument. For example,
> +``/log?style=atom``. The hyphenated URL parameter is preferred.
> +
> +Not all templates are available for all styles. Attempting to use
> +a style that doesn't have all templates defined may result in an error
> +rendering the page.
> +
> +Many commands take a ``{revision}`` URL parameter. This defines the
> +changeset to operate on. This is commonly specified as the short,
> +12 digit hexidecimal abbreviation for the full 40 character unique
> +revision identifier. However, any value described by
> +:hg:`help revisions` typically works.
>
Sean Farley - Feb. 7, 2015, 11:01 p.m.
Gregory Szorc writes:

> It appears I can't resolve conflicts properly :/
>
> I'll spare everyone a resend.

Could you amend and put somewhere to pull?
Gregory Szorc - Feb. 8, 2015, 1:25 a.m.
I fixed the conflict markers and removed the outdated comment about __all__
and pushed to the hgweb-help bookmark at http://hg.gregoryszorc.com/hg.
686f2fc03b5e

On Sat, Feb 7, 2015 at 3:01 PM, Sean Farley <sean.michael.farley@gmail.com>
wrote:

>
> Gregory Szorc writes:
>
> > It appears I can't resolve conflicts properly :/
> >
> > I'll spare everyone a resend.
>
> Could you amend and put somewhere to pull?
>

Patch

diff --git a/mercurial/help/hgweb.txt b/mercurial/help/hgweb.txt
--- a/mercurial/help/hgweb.txt
+++ b/mercurial/help/hgweb.txt
@@ -47,4 +47,43 @@  In this example::
   and ``http://server/user/bob/quux/testsubrepo/``
 
 The ``collections`` section is deprecated and has been superseded by
 ``paths``.
+<<<<<<< local
+||||||| base
+
+Web Commands / URLs
+===================
+
+The following web commands / URL handlers are registered:
+
+  .. webcommandsmarker
+=======
+
+URLs and Common Arguments
+=========================
+
+URLs under each repository have the form ``/{command}[/{arguments}]``
+where ``{command}`` represents the name of a command or handler and
+``{arguments}`` represents any number of additional URL parameters
+to that command.
+
+The web server has a default style associated with it. Styles map to
+a collection of named templates. Each template is used to render a
+specific piece of data, such as a changeset or diff.
+
+The style for the current request can be overwritten two ways. First,
+if ``{command}`` contains a hyphen (``-``), the text before the hyphen
+defines the style. For example, ``/atom-log`` will render the ``log``
+command handler with the ``atom`` style. The second way to set the
+style is with the ``style`` query string argument. For example,
+``/log?style=atom``. The hyphenated URL parameter is preferred.
+
+Not all templates are available for all styles. Attempting to use
+a style that doesn't have all templates defined may result in an error
+rendering the page.
+
+Many commands take a ``{revision}`` URL parameter. This defines the
+changeset to operate on. This is commonly specified as the short,
+12 digit hexidecimal abbreviation for the full 40 character unique
+revision identifier. However, any value described by
+:hg:`help revisions` typically works.