Mercurial > hg-stable

changeset 8894:868670dbc237

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
extensions: improve the consistency of synopses Trying as much as possible to consistently: - use a present tense predicate followed by a direct object - verb referring directly to the functionality provided (ie. not "add command that does this" but simple "do that") - keep simple and to the point, leaving details for the long help (width is tight, possibly even more so for translations) Thanks to timeless, Martin Geisler, Rafael Villar Burke, Dan Villiom Podlaski Christiansen and others for the helpful suggestions.
author Cédric Duval <cedricduval@free.fr>
date Mon, 22 Jun 2009 15:48:08 +0200
parents cc0593af30d4
children ef59f4634a15
files hgext/acl.py hgext/bookmarks.py hgext/bugzilla.py hgext/children.py hgext/churn.py hgext/color.py hgext/convert/__init__.py hgext/fetch.py hgext/gpg.py hgext/graphlog.py hgext/hgcia.py hgext/hgk.py hgext/highlight/__init__.py hgext/inotify/__init__.py hgext/keyword.py hgext/mq.py hgext/notify.py hgext/pager.py hgext/parentrevspec.py hgext/patchbomb.py hgext/purge.py hgext/record.py hgext/share.py hgext/transplant.py hgext/win32mbcs.py hgext/win32text.py hgext/zeroconf/__init__.py tests/test-keyword.out tests/test-mq.out tests/test-notify.out
diffstat 30 files changed, 36 insertions(+), 38 deletions(-) [+]
line wrap: on
line diff
--- a/hgext/acl.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/acl.py	Mon Jun 22 15:48:08 2009 +0200
@@ -6,7 +6,7 @@
 # GNU General Public License version 2, incorporated herein by reference.
 #
 
-'''provide simple hooks for access control
+'''control access to a repository using simple hooks
 
 This hook makes it possible to allow or deny write access to portions
 of a repository when receiving incoming changesets.
--- a/hgext/bookmarks.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/bookmarks.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''Mercurial bookmarks
+'''track a line of development with movable markers
 
 Bookmarks are local movable markers to changesets. Every bookmark
 points to a changeset identified by its hash. If you commit a
@@ -122,7 +122,7 @@
     repo._bookmarkcurrent = mark
 
 def bookmark(ui, repo, mark=None, rev=None, force=False, delete=False, rename=None):
-    '''Mercurial bookmarks
+    '''track a line of development with movable markers
 
     Bookmarks are pointers to certain commits that move when
     committing. Bookmarks are local. They can be renamed, copied and
--- a/hgext/bugzilla.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/bugzilla.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''Bugzilla integration
+'''integrate Mercurial with a Bugzilla bug tracker
 
 This hook extension adds comments on bugs in Bugzilla when changesets
 that refer to bugs by Bugzilla ID are seen. The hook does not change
--- a/hgext/children.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/children.py	Mon Jun 22 15:48:08 2009 +0200
@@ -8,7 +8,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''provides children command to show children changesets'''
+'''display children changesets'''
 
 from mercurial import cmdutil
 from mercurial.commands import templateopts
--- a/hgext/churn.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/churn.py	Mon Jun 22 15:48:08 2009 +0200
@@ -6,7 +6,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''command to show certain statistics about revision history'''
+'''display statistics about repository history'''
 
 from mercurial.i18n import _
 from mercurial import patch, cmdutil, util, templater
--- a/hgext/color.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/color.py	Mon Jun 22 15:48:08 2009 +0200
@@ -16,7 +16,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-'''add color output to status, qseries, and diff-related commands
+'''colorize output from some commands
 
 This extension modifies the status command to add color to its output
 to reflect file status, the qseries command to add color to reflect
--- a/hgext/convert/__init__.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/convert/__init__.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''converting foreign VCS repositories to Mercurial'''
+'''import from foreign VCS repositories into Mercurial'''
 
 import convcmd
 import cvsps
--- a/hgext/fetch.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/fetch.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''pulling, updating and merging in one command'''
+'''pull, update and merge in one command'''
 
 from mercurial.i18n import _
 from mercurial.node import nullid, short
--- a/hgext/gpg.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/gpg.py	Mon Jun 22 15:48:08 2009 +0200
@@ -3,7 +3,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''GnuPG signing extension for Mercurial'''
+'''sign and verify changesets'''
 
 import os, tempfile, binascii
 from mercurial import util, commands, match
--- a/hgext/graphlog.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/graphlog.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''show revision graphs in terminal windows
+'''show revision graphs in terminals
 
 This extension adds a --graph option to the incoming, outgoing and log
 commands. When this options is given, an ASCII representation of the
--- a/hgext/hgcia.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/hgcia.py	Mon Jun 22 15:48:08 2009 +0200
@@ -1,7 +1,7 @@
 # Copyright (C) 2007-8 Brendan Cully <brendan@kublai.com>
 # Published under the GNU GPL
 
-"""CIA notification
+"""integrate Mercurial with a CIA notification service
 
 This is meant to be run as a changegroup or incoming hook.
 To configure it, set the following options in your hgrc:
--- a/hgext/hgk.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/hgk.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''browsing the repository in a graphical way
+'''browse the repository in a graphical way
 
 The hgk extension allows browsing the history of a repository in a
 graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not
--- a/hgext/highlight/__init__.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/highlight/__init__.py	Mon Jun 22 15:48:08 2009 +0200
@@ -8,7 +8,7 @@
 # The original module was split in an interface and an implementation
 # file to defer pygments loading and speedup extension setup.
 
-"""syntax highlighting in hgweb, based on Pygments
+"""syntax highlighting for hgweb
 
 It depends on the Pygments syntax highlighting library:
 http://pygments.org/
--- a/hgext/inotify/__init__.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/inotify/__init__.py	Mon Jun 22 15:48:08 2009 +0200
@@ -6,8 +6,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''inotify-based status acceleration for Linux systems
-'''
+'''accelerate status report using system level services'''
 
 # todo: socket permissions
 
--- a/hgext/keyword.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/keyword.py	Mon Jun 22 15:48:08 2009 +0200
@@ -26,7 +26,7 @@
 #
 # Run "hg help keyword" and "hg kwdemo" to get info on configuration.
 
-'''keyword expansion in tracked files
+'''expand keywords in tracked files
 
 This extension expands RCS/CVS-like or self-customized $Keywords$ in
 tracked text files selected by your configuration.
--- a/hgext/mq.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/mq.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''patch management and development
+'''work with a stack of patches
 
 This extension lets you work with a stack of patches in a Mercurial
 repository. It manages two stacks of patches - all known patches, and
--- a/hgext/notify.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/notify.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''hook extension to email notifications on commits/pushes
+'''send e-mail notifications for commits/pushes
 
 Subscriptions can be managed through hgrc. Default mode is to print
 messages to stdout, for testing and configuring.
--- a/hgext/pager.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/pager.py	Mon Jun 22 15:48:08 2009 +0200
@@ -12,7 +12,7 @@
 #
 # Run "hg help pager" to get info on configuration.
 
-'''browse command output with external pager
+'''browse command output with an external pager
 
 To set the pager that should be used, set the application variable:
 
--- a/hgext/parentrevspec.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/parentrevspec.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''use suffixes to refer to ancestor revisions
+'''interpret suffixes to refer to ancestor revisions
 
 This extension allows you to use git-style suffixes to refer to the
 ancestors of a specific revision.
--- a/hgext/patchbomb.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/patchbomb.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''sending Mercurial changesets as a series of patch emails
+'''send Mercurial changesets as a series of patch e-mails
 
 The series is started off with a "[PATCH 0 of N]" introduction, which
 describes the series as a whole.
--- a/hgext/purge.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/purge.py	Mon Jun 22 15:48:08 2009 +0200
@@ -23,7 +23,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-'''enable removing untracked files only'''
+'''delete files not tracked from the working directory'''
 
 from mercurial import util, commands, cmdutil
 from mercurial.i18n import _
--- a/hgext/record.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/record.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''interactive change selection during commit or qrefresh'''
+'''interactively select which sets of changes to commit/qrefresh'''
 
 from mercurial.i18n import gettext, _
 from mercurial import cmdutil, commands, extensions, hg, mdiff, patch
--- a/hgext/share.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/share.py	Mon Jun 22 15:48:08 2009 +0200
@@ -3,7 +3,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''provides the hg share command'''
+'''share a common history between several working directories'''
 
 import os
 from mercurial.i18n import _
--- a/hgext/transplant.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/transplant.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''patch transplanting tool
+'''transplant changesets from another branch
 
 This extension allows you to transplant patches from another branch.
 
--- a/hgext/win32mbcs.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/win32mbcs.py	Mon Jun 22 15:48:08 2009 +0200
@@ -9,7 +9,7 @@
 # GNU General Public License version 2, incorporated herein by reference.
 #
 
-"""allow to use MBCS path with problematic encoding.
+'''allow the use of MBCS paths with problematic encoding
 
 Some MBCS encodings are not good for some path operations (i.e.
 splitting path, case conversion, etc.) with its encoded bytes. We call
@@ -36,8 +36,7 @@
 Path encoding conversion are done between Unicode and
 encoding.encoding which is decided by Mercurial from current locale
 setting or HGENCODING.
-
-"""
+'''
 
 import os
 from mercurial.i18n import _
--- a/hgext/win32text.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/win32text.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''LF <-> CRLF/CR translation utilities
+'''perform automatic newline conversion
 
 To perform automatic newline conversion, use:
 
--- a/hgext/zeroconf/__init__.py	Mon Jun 22 14:49:07 2009 +0200
+++ b/hgext/zeroconf/__init__.py	Mon Jun 22 15:48:08 2009 +0200
@@ -5,7 +5,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
-'''zeroconf support for Mercurial repositories
+'''discover and advertise repositories on the local network
 
 Zeroconf enabled repositories will be announced in a network without
 the need to configure a server or a service. They can be discovered
--- a/tests/test-keyword.out	Mon Jun 22 14:49:07 2009 +0200
+++ b/tests/test-keyword.out	Mon Jun 22 15:48:08 2009 +0200
@@ -1,5 +1,5 @@
 % help
-keyword extension - keyword expansion in tracked files
+keyword extension - expand keywords in tracked files
 
 This extension expands RCS/CVS-like or self-customized $Keywords$ in
 tracked text files selected by your configuration.
@@ -55,9 +55,9 @@
 
 enabled extensions:
 
- keyword   keyword expansion in tracked files
- mq        patch management and development
- notify    hook extension to email notifications on commits/pushes
+ keyword   expand keywords in tracked files
+ mq        work with a stack of patches
+ notify    send e-mail notifications for commits/pushes
 
 use "hg -v help keyword" to show aliases and global options
 % hg kwdemo
--- a/tests/test-mq.out	Mon Jun 22 14:49:07 2009 +0200
+++ b/tests/test-mq.out	Mon Jun 22 15:48:08 2009 +0200
@@ -1,5 +1,5 @@
 % help
-mq extension - patch management and development
+mq extension - work with a stack of patches
 
 This extension lets you work with a stack of patches in a Mercurial
 repository. It manages two stacks of patches - all known patches, and
@@ -53,7 +53,7 @@
 
 enabled extensions:
 
- mq   patch management and development
+ mq   work with a stack of patches
 
 use "hg -v help mq" to show aliases and global options
 adding a
--- a/tests/test-notify.out	Mon Jun 22 14:49:07 2009 +0200
+++ b/tests/test-notify.out	Mon Jun 22 15:48:08 2009 +0200
@@ -1,4 +1,4 @@
-notify extension - hook extension to email notifications on commits/pushes
+notify extension - send e-mail notifications for commits/pushes
 
 Subscriptions can be managed through hgrc. Default mode is to print
 messages to stdout, for testing and configuring.