Improve Mercurial's built-in help

Abstract

Mercurial's built-in help is quite good, but could be better. The improvement on help system contains 4 tasks:

  1. migrate remaining contents from manpages into built-in help;
  2. new feature of 'hg help -k keyword';
  3. add example usages to verbose sections in help;
  4. mark up more keywords in hg text role to link topics to each other tightly
  5. Improve HTML rendering in hgweb view to support hype link

Milestones

The improvement on help system contains 5 tasks, and milestones are provided in the 5 tasks accordingly. I will begin my GSOC work just from late April. As I'm not so free before summer, I will spent 12 hours on GSOC per week, while 40 hours in Summer.

1.migrate remaining contents from manpages into built-in help (April 20 to April 30)

MileStone:

2. new feature of 'hg help -k keyword' (May 1 to June 25)

2.1 Where is the information from?

2.2 How to judge a 'help infomation block' hits the keyword

2.3 How does the results organize?

MileStone:

3.add example usages to verbose sections in help (June 1 to July 5)

MileStone:

MileStone:

MileStone:

About Me

I'm a girl postgraduate, majoring in Computer Science.

I have passed GSOC 2010 with DERBY as my project[1]. And this year, I'm interested in Mercurial and wish to do some contribution for this smart distributed VCS.

I have set up the development environment on Ubuntu, read the code related to help system and done some hacking on it. Furthermore, I have created some issues[2.] on BTS and provided some patches, some of them are accepted, and some are in queue. Much of my work relates closely to my proposal title "Improve Mercurial's built-in help". Besides, in my communication in mailing list and IRC, I have got much advice and encouragement.

Contact Info

[1.]

[2.]


CategoryGsoc

SummerOfCode/2011/YunLee (last edited 2013-08-29 12:31:54 by AugieFackler)