Patchwork help: update help for hgweb template and style (issue4373)

login
register
mail settings
Submitter Arun Chandrasekaran
Date Sept. 20, 2014, 9:25 p.m.
Message ID <f67383d38119ce7f3037.1411248359@NTI-EB2560-Arun.gateway.innflux.com>
Download mbox | patch
Permalink /patch/5906/
State Accepted
Headers show

Comments

Arun Chandrasekaran - Sept. 20, 2014, 9:25 p.m.
# HG changeset patch
# User Arun Chandrasekaran <visionofarun@gmail.com>
# Date 1411247799 25200
#      Sat Sep 20 14:16:39 2014 -0700
# Node ID f67383d38119ce7f303756f8fa8dcaf6e466d688
# Parent  5e16fe6fdd32124c3295db5ec40b076084cc5bd4
help: update help for hgweb template and style (issue4373)
Augie Fackler - Sept. 23, 2014, 6:18 p.m.
On Sat, Sep 20, 2014 at 02:25:59PM -0700, Arun Chandrasekaran wrote:
> # HG changeset patch
> # User Arun Chandrasekaran <visionofarun@gmail.com>
> # Date 1411247799 25200
> #      Sat Sep 20 14:16:39 2014 -0700
> # Node ID f67383d38119ce7f303756f8fa8dcaf6e466d688
> # Parent  5e16fe6fdd32124c3295db5ec40b076084cc5bd4
> help: update help for hgweb template and style (issue4373)

Looks reasonable. Queued, and I'll do a follow-up of my own for a nit
I list below.

>
> diff -r 5e16fe6fdd32 -r f67383d38119 mercurial/help/config.txt
> --- a/mercurial/help/config.txt	Sat Aug 30 02:25:23 2014 +0200
> +++ b/mercurial/help/config.txt	Sat Sep 20 14:16:39 2014 -0700
> @@ -1640,10 +1640,13 @@
>      Default is 1; set to 0 to disable.
>
>  ``style``
> -    Which template map style to use.
> +    Which template map style to use. The available options are the names of
> +    subdirectories in the HTML templates path.
> +    Example: ``monoblue``

Probably worth mentioning that the default is paper. I'll add that in
a followup.

>
>  ``templates``
> -    Where to find the HTML templates. Default is install path.
> +    Where to find the HTML templates. The default path to the HTML templates
> +    can be obtained from ``hg debuginstall``.
>
>  ``websub``
>  ----------
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel@selenic.com
> http://selenic.com/mailman/listinfo/mercurial-devel
Pierre-Yves David - Sept. 23, 2014, 11:46 p.m.
On 09/23/2014 11:18 AM, Augie Fackler wrote:
> On Sat, Sep 20, 2014 at 02:25:59PM -0700, Arun Chandrasekaran wrote:
>> # HG changeset patch
>> # User Arun Chandrasekaran <visionofarun@gmail.com>
>> # Date 1411247799 25200
>> #      Sat Sep 20 14:16:39 2014 -0700
>> # Node ID f67383d38119ce7f303756f8fa8dcaf6e466d688
>> # Parent  5e16fe6fdd32124c3295db5ec40b076084cc5bd4
>> help: update help for hgweb template and style (issue4373)
>
> Looks reasonable. Queued, and I'll do a follow-up of my own for a nit
> I list below.

Not super fan of pointing people at directory structure. Could we get an 
official way to list available template instead ?
Mads Kiilerich - Sept. 24, 2014, 12:37 a.m.
On 09/24/2014 01:46 AM, Pierre-Yves David wrote:
>
>
> On 09/23/2014 11:18 AM, Augie Fackler wrote:
>> On Sat, Sep 20, 2014 at 02:25:59PM -0700, Arun Chandrasekaran wrote:
>>> # HG changeset patch
>>> # User Arun Chandrasekaran <visionofarun@gmail.com>
>>> # Date 1411247799 25200
>>> #      Sat Sep 20 14:16:39 2014 -0700
>>> # Node ID f67383d38119ce7f303756f8fa8dcaf6e466d688
>>> # Parent  5e16fe6fdd32124c3295db5ec40b076084cc5bd4
>>> help: update help for hgweb template and style (issue4373)
>>
>> Looks reasonable. Queued, and I'll do a follow-up of my own for a nit
>> I list below.
>
> Not super fan of pointing people at directory structure. Could we get 
> an official way to list available template instead ?

The directory structure is also the place users could put their own 
templates. It would be nice if these data not were hidden in the middle 
of the python code but I don't think we could/should hide the location.

/Mads
Pierre-Yves David - Sept. 24, 2014, 12:38 a.m.
On 09/23/2014 05:37 PM, Mads Kiilerich wrote:
> On 09/24/2014 01:46 AM, Pierre-Yves David wrote:
>>
>>
>> On 09/23/2014 11:18 AM, Augie Fackler wrote:
>>> On Sat, Sep 20, 2014 at 02:25:59PM -0700, Arun Chandrasekaran wrote:
>>>> # HG changeset patch
>>>> # User Arun Chandrasekaran <visionofarun@gmail.com>
>>>> # Date 1411247799 25200
>>>> #      Sat Sep 20 14:16:39 2014 -0700
>>>> # Node ID f67383d38119ce7f303756f8fa8dcaf6e466d688
>>>> # Parent  5e16fe6fdd32124c3295db5ec40b076084cc5bd4
>>>> help: update help for hgweb template and style (issue4373)
>>>
>>> Looks reasonable. Queued, and I'll do a follow-up of my own for a nit
>>> I list below.
>>
>> Not super fan of pointing people at directory structure. Could we get
>> an official way to list available template instead ?
>
> The directory structure is also the place users could put their own
> templates. It would be nice if these data not were hidden in the middle
> of the python code but I don't think we could/should hide the location.

I think not exposing it in the default case would be more sensible (okay 
for making it discoverable for people writing there own template)

Patch

diff -r 5e16fe6fdd32 -r f67383d38119 mercurial/help/config.txt
--- a/mercurial/help/config.txt	Sat Aug 30 02:25:23 2014 +0200
+++ b/mercurial/help/config.txt	Sat Sep 20 14:16:39 2014 -0700
@@ -1640,10 +1640,13 @@ 
     Default is 1; set to 0 to disable.
 
 ``style``
-    Which template map style to use.
+    Which template map style to use. The available options are the names of
+    subdirectories in the HTML templates path.
+    Example: ``monoblue``
 
 ``templates``
-    Where to find the HTML templates. Default is install path.
+    Where to find the HTML templates. The default path to the HTML templates
+    can be obtained from ``hg debuginstall``.
 
 ``websub``
 ----------