Bug 1182677 - Add doctstring for mach mercurial-setup; r=smacleod

Mach grew support for docstrings in `mach help` output a few weeks ago.
Add a docstring for `mach mercurial-setup`.
This commit is contained in:
Gregory Szorc 2015-07-14 13:44:08 -07:00
parent 51d9d0fcb8
commit 9d05a6e264

View File

@ -23,7 +23,20 @@ class VersionControlCommands(object):
description='Help configure Mercurial for optimal development.')
@CommandArgument('-u', '--update-only', action='store_true',
help='Only update recommended extensions, don\'t run the wizard.')
def mercurial_bootstrap(self, update_only=False):
def mercurial_setup(self, update_only=False):
"""Ensure Mercurial is optimally configured.
This command will inspect your Mercurial configuration and
guide you through an interactive wizard helping you configure
Mercurial for optimal use on Mozilla projects.
User choice is respected: no changes are made without explicit
confirmation from you.
If "--update-only" is used, the interactive wizard is disabled
and this command only ensures that remote repositories providing
Mercurial extensions are up to date.
"""
sys.path.append(os.path.dirname(__file__))
config_paths = ['~/.hgrc']