Bug 1115278 - Fix mach documentation issues; r=glandium
authorGregory Szorc <gps@mozilla.com>
Wed, 24 Dec 2014 10:26:34 -0800
changeset 221524 9acf0e1ecae6878d71e0aebdf7b2f322ca8d1582
parent 221523 245bebb9e0d23070b3708d8f4ae45c85efb126b9
child 221525 11e3df6283a05732f564c3bde728dba3847665ad
push id28032
push userkwierso@gmail.com
push dateTue, 30 Dec 2014 01:28:14 +0000
treeherdermozilla-central@67872ce17918 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersglandium
bugs1115278
milestone37.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1115278 - Fix mach documentation issues; r=glandium terminal.py had an ambiguous |import logging| that was importing mach.logging from Sphinx. We fix it. There was also a poorly formed link in the mach commands documentation. We fix it.
python/mach/docs/commands.rst
python/mach/mach/terminal.py
--- a/python/mach/docs/commands.rst
+++ b/python/mach/docs/commands.rst
@@ -18,17 +18,17 @@ The important decorators are as follows:
   the specified command is requested. The decorator takes a command name
   as its first argument and a number of additional arguments to
   configure the behavior of the command.
 
 :py:func:`CommandArgument <mach.decorators.CommandArgument>`
   A method decorator that defines an argument to the command. Its
   arguments are essentially proxied to ArgumentParser.add_argument()
 
-:py:func:`SubCommand <mach.decorators.SubCommand`
+:py:func:`SubCommand <mach.decorators.SubCommand>`
   A method decorator that denotes that the method should be a
   sub-command to an existing ``@Command``. The decorator takes the
   parent command name as its first argument and the sub-command name
   as its second argument.
 
   ``@CommandArgument`` can be used on ``@SubCommand`` instances just
   like they can on ``@Command`` instances.
 
--- a/python/mach/mach/terminal.py
+++ b/python/mach/mach/terminal.py
@@ -3,17 +3,17 @@
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 """This file contains code for interacting with terminals.
 
 All the terminal interaction code is consolidated so the complexity can be in
 one place, away from code that is commonly looked at.
 """
 
-from __future__ import print_function, unicode_literals
+from __future__ import absolute_import, print_function, unicode_literals
 
 import logging
 import sys
 
 
 class LoggingHandler(logging.Handler):
     """Custom logging handler that works with terminal window dressing.