672321 - pushlog extension dose not have proper installation instructions

Status: RESOLVED FIXED

(Developer Services :: Mercurial: hg.mozilla.org, defect)

Description

[Pradeepkumar Gayam]

User Agent: Mozilla/5.0 (X11; Linux i686) AppleWebKit/534.30 (KHTML, like Gecko) Ubuntu/11.04 Chromium/12.0.742.112 Chrome/12.0.742.112 Safari/534.30

Steps to reproduce:

Try to install pushlog


Actual results:

Didn't work.


Expected results:

pushlog extension installation is not as trivial as other extensions. It needs special templates which are not shipped with mercurial. Placing the these templates is not something ordinary users expected to do. pushlog generates feed from entries of database which is filled by hook. This is not mentioned in README file.

Summery: It needs proper installation instructions.

Comment 1

[Dustin J. Mitchell [:dustin] (he/him)]

Pradeep is a GSoC student (for Buildbot), and will be working on said documentation.

Comment 2

[Dirkjan Ochtman (:djc)]

Ah, good. I'm available for review if needed.

Comment 3

[(not currently active) Ted Mielczarek]

Armen blogged some useful info a while ago:
http://armenzg.blogspot.com/2008/12/setup-your-own-hg-local-repo-with.html

Comment 4

[Pradeepkumar Gayam]

Attachment: 67.diff

Comment 5

[Dustin J. Mitchell [:dustin] (he/him)]

Comment on attachment 546692 [details] [diff] [review]
67.diff

Looks good.  A quick copy-edit:

>Pushlog ATOM feed requires special templates which can be found in
>http://hg.mozilla.org/hgcustom/hg_templates/
>Add the fallowing in .hg/hgrc to configure this custom templates.
Add the fallowing in .hg/hgrc to configure these custom templates.
>
>[web]
>templates = /path/to/hg_templates
>style = gitweb_mozilla
>
>or you can do it hardway by replacing atom folder in mercurial/templates/
or you can do it the hard way by replacing the atom folder in mercurial/templates/
>in mercurial installation folder with hg_templace/atom.
>
>To setup pushlog extension put the fallowing in .hg/hgrc of the 
To setup the pushlog extension, put the fallowing in .hg/hgrc in the 
>repository or in ~/.hgrc
repository, or in ~/.hgrc
>
>[extensions]
>pushlog-feed = /path/to/pushlog-feed.py
>
>With the above setup pushlog webcommand works without any error but the feed
>will be empty.
With the above setup, the pushlog webcommand will work without any error, but 
the feed will be empty.
>
>To get the feed of the commits setup a hook which makes entries of each commit
>in database from which pushlog find the information about new commits.The hook
>can be found in http://hg.mozilla.org/hgcustom/hghooks/. You can setup the hook
>by keeping the fallowing in the .hg/hgrc of repository.
To set up the feed of the commits, add a hook which makes entries for each commit
in the database. The pushlog will use these entries to show the feed.  The hook
can be found in http://hg.mozilla.org/hgcustom/hghooks/. After installing the hook,
add the fallowing to the repository's .hg/hgrc:
>
>pretxnchangegroup.pushlog_hook = python:mozhghooks.pushlog.log
>
>Change the type of hook according to your need. Find more info about hooks at
>http://mercurial.selenic.com/wiki/Hook
>
>URL of the pushlog feed would be http://example.com/yourrepo/pushlog
The URL of the pushlog feed will be http://example.com/yourrepo/pushlog

----

The README names two extensions, but this INSTALL file only names one - why?

Is there anything in Armen's blog entry that should be added here?  Perhaps a
link to the blog entry in the INSTALL file would be useful?

Please fix up the copy, make any other adjustments, add a new patch, and set review? = :djc

Comment 6

[Pradeepkumar Gayam]

Attachment: patch for INSTALL file

Comment 7

[Dirkjan Ochtman (:djc)]

Comment on attachment 546869 [details] [diff] [review]
patch for INSTALL file

>diff -r e99a36d3fd4a INSTALL
>--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
>+++ b/INSTALL	Wed Jul 20 01:13:18 2011 +0530
>@@ -0,0 +1,35 @@
>+Pushlog ATOM feed requires special templates which can be found in

Nit: ATOM is not an acronym, just make it Atom. Also, you should either specify that the following instructions are *just* for the pushlog, or how much of them applies to all of the extensions. Perhaps a nice list with 1 line explanations of each extension would be within the realm of possibilities?

>+http://hg.mozilla.org/hgcustom/hg_templates/
>+Add the fallowing in .hg/hgrc to configure these custom templates.

Nit: fallowing -> following.

>+
>+[web]
>+templates = /path/to/hg_templates
>+style = gitweb_mozilla
>+
>+or you can do it the hard way by replacing the atom folder in mercurial/templates/
>+in mercurial installation folder with hg_templace/atom.

Should be hg_templates/atom, not hg_templace/atom. Also, I would leave the hard way out of this, the short way seems good enough (and can also be enacted in /etc/mercurial/hgrc, for example, if you want to force it for the whole machine).

>+
>+To setup the pushlog extension, put the fallowing in .hg/hgrc in the
>+repository or in ~/.hgrc

Fallowing -> following.

>+
>+[extensions]
>+pushlog-feed = /path/to/pushlog-feed.py
>+
>+With the above setup, the pushlog webcommand will work without any error, but
>+the feed will be empty.
>+
>+To set up the feed of the commits, add a hook which makes entries for each commit
>+in the database. The pushlog will use these entries to show the feed.  The hook
>+can be found in http://hg.mozilla.org/hgcustom/hghooks/. After installing the hook,
>+add the fallowing to the repository's .hg/hgrc:

Fallowing -> following.

>+
>+pretxnchangegroup.pushlog_hook = python:mozhghooks.pushlog.log
>+
>+Change the type of hook according to your need. Find more info about hooks at
>+http://mercurial.selenic.com/wiki/Hook

Presumably the hook code in pushlog won't work for every kind of hook, perhaps you could be more specific here to explain for which hooks it makes sense?

>+
>+The URL of the pushlog feed will be http://example.com/yourrepo/pushlog
>+
>+You can find some useful information in
>+http://armenzg.blogspot.com/2008/12/setup-your-own-hg-local-repo-with.html
>+
>diff -r e99a36d3fd4a README
>--- a/README	Thu Jan 06 09:05:16 2011 -0500
>+++ b/README	Wed Jul 20 01:13:18 2011 +0530
>@@ -11,9 +11,4 @@
> pushes were made to a repository, what the head revision was at the time, and
> who performed the push.
> 
>-To install these extensions for use in apache, place the following .hgrc
>-file in the apache home directory (/var/www/.hgrc on FC8):
>-
>-[extensions]
>-hgwebjson = /path/to/hgwebjson.py
>-pushlog-feed = /path/to/pushlog-feed.py
>+See INSTALL for information about installation
>\ No newline at end of file

You should fix the lack of a newline here.

Comment 8

[Dirkjan Ochtman (:djc)]

Also, I'm going to be gone for two weeks. Feel free to ask someone else (probably Ted) for a review if you need one.

Comment 9

[Gregory Szorc [:gps]]

https://hg.mozilla.org/hgcustom/version-control-tools/rev/e07b4eb537b3

Comment 10

[Gregory Szorc [:gps]]

See https://mozilla-version-control-tools.readthedocs.org/en/latest/hgmo/pushlog.html