gecko-dev/python
Gregory Szorc 67e6a15a08 Bug 1173633 - Print docstrings of mach command handlers in help output; r=ahal
`mach help <command>` currently only displays a brief description of the
command along with its arguments. Sometimes more detailed help text is
needed.

With this commit, the docstrings of mach command handlers will appear in
the output of `mach help <command>` if they are defined.

I've implemented basic docstrings for the three flavors of mach commands
(normal command, main subcommand, subcommand) to demonstate things work.

My hope is others will start to fill in docstrings once this feature
lands so the output for `mach help` can serve as a better learning guide
for new contributors.

--HG--
extra : commitid : Hx6ZkHDxbCK
extra : rebase_source : 01ced5a044442e370a45cd3fb245ac6283316925
extra : amend_source : fceb771e0e1ffa4e6f3f1b7c22eae6e25cf82034
2015-06-11 08:32:02 -07:00
..
bitstring Bug 1091668 - Import bitstring-3.1.3; r=ted, r=gerv 2014-11-03 10:47:25 -05:00
blessings
compare-locales Bug 1165906 - Add docs for l10n to the tree. r=gps 2015-06-01 17:13:44 +02:00
configobj
eme Bug 1139125 - Add Windows 64-bit support and certificate chain support to Adobe EME voucher tool. r=ted 2015-05-15 15:26:52 +12:00
jsmin Bug 1105052 - Update in-tree jsmin to commit a878bf0. rs=gps 2014-11-25 16:02:08 -08:00
lldbutils Bug 1151349 - Make lldb ns(Int)Region summary handle the numRects==0 case. r=jrmuizel 2015-04-05 14:06:43 -04:00
mach Bug 1173633 - Print docstrings of mach command handlers in help output; r=ahal 2015-06-11 08:32:02 -07:00
mock-1.0.0
mozboot Bug 1165422 - Bump mach bootstrap versions for SDK 22. r?nalexander 2015-06-04 10:53:24 -07:00
mozbuild Bug 1173633 - Print docstrings of mach command handlers in help output; r=ahal 2015-06-11 08:32:02 -07:00
mozversioncontrol/mozversioncontrol Bug 1128586 - Properly look for Mercurial version; r=RyanVM 2015-04-27 10:43:25 -07:00
psutil Backed out changeset 697eb6db7d96 (bug 930808) for OS X make check failures 2014-12-23 21:04:19 -08:00
pyasn1 Bug 1091668 - Import pyasn1-0.1.7; r=ted, r=gerv 2014-11-03 10:46:46 -05:00
pyasn1-modules bug 1166976 - add pyasn1-modules python library r=ted,gerv 2015-05-20 16:33:23 -07:00
pystache Bug 1068653 - Part 1 Add python dependencies for taskcluster mach commands r=gps 2014-11-26 10:11:28 -08:00
pyyaml Bug 1068653 - Part 1 Add python dependencies for taskcluster mach commands r=gps 2014-11-26 10:11:28 -08:00
redo Bug 1118774 - Import python redo library; r=gps 2015-01-07 14:18:20 -05:00
requests bug 1135700 - Import the Python requests module. r=gps 2015-02-23 11:27:50 -05:00
rsa bug 1166976 - add Python-RSA python library r=ted,gerv 2015-05-20 16:34:03 -07:00
virtualenv Bug 1119350 - Upgrade virtualenv to 12.0.5; r=gps 2015-01-08 10:52:07 -07:00
which Bug 1119776, Part 7: Avoid defining snprintf when MSVC provides it (other), r=bsmedberg 2015-01-08 22:35:33 -08:00
README Bug 1068653 - Part 1 Add python dependencies for taskcluster mach commands r=gps 2014-11-26 10:11:28 -08:00
mach_commands.py Bug 1147283 - Replace mozpack.path with mozpath. r=mshal 2015-03-27 08:13:16 +09:00
moz.build Bug 910660 - Add a test for the unpacker code. r=gps 2015-03-24 09:10:32 +09:00

README

This directory contains common Python code.

The basic rule is that if Python code is cross-module (that's "module" in the
Mozilla meaning - as in "module ownership") and is MPL-compatible, it should
go here.

What should not go here:

* Python that is not MPL-compatible (see other-licenses/)
* Python that has good reason to remain close to its "owning" (Mozilla)
  module (e.g. it is only being consumed from there).

Historical information can be found at
https://bugzilla.mozilla.org/show_bug.cgi?id=775243

## pyyaml | pystache

Used in taskcluster related mach commands to update download from github
and remove .git and tests.

Then run tests in taskcluster/tests/