Bug 1746286: Don't recommend adding "Mach" to your PATH r=ahal
authorMitchell Hentges <mhentges@mozilla.com>
Thu, 13 Jan 2022 21:39:39 +0000
changeset 604512 282ec13a01eaa7256718d47ead596146adea9927
parent 604511 eff3d414e54a47ea96f9d303447b217807389d62
child 604513 b7f12f1ea6102c4f602e56a3f9283846e15ca6c8
push id39149
push userctuns@mozilla.com
push dateFri, 14 Jan 2022 09:31:02 +0000
treeherdermozilla-central@99d93c593aad [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersahal
bugs1746286
milestone98.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 1746286: Don't recommend adding "Mach" to your PATH r=ahal This can cause issues when Mach from sourcetree A fails when used in sourcetree B because an expected file is missing. Differential Revision: https://phabricator.services.mozilla.com/D133951
docs/contributing/debugging/debugging_firefox_with_gdb.rst
python/mach/docs/usage.rst
--- a/docs/contributing/debugging/debugging_firefox_with_gdb.rst
+++ b/docs/contributing/debugging/debugging_firefox_with_gdb.rst
@@ -26,18 +26,17 @@ https://sourceware.org/gdb/current/onlin
 
 How do I run Firefox under gdb?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The preferred method, is using the
 :ref:`mach` command-line tool to run the
 debugger, which can bypass several optional defaults. Use "mach help
 run" to get more details. If inside the source directory, you would use
-"./mach". If you have previously :ref:`added mach to your path <Adding_mach_to_your_shell>`,
-then just use "mach". Please note that :ref:`mach is aware of mozconfigs <mach_and_mozconfigs>`.
+"./mach". Please note that :ref:`mach is aware of mozconfigs <mach_and_mozconfigs>`.
 
 .. code:: bash
 
    $ ./mach run --debug [arguments to pass to firefox]
 
 If you need to direct arguments to gdb, you can use '--debugger-args'
 options via the command line parser, taking care to adhere to shell
 splitting rules. For example, if you wanted to run the command 'show
--- a/python/mach/docs/usage.rst
+++ b/python/mach/docs/usage.rst
@@ -141,19 +141,10 @@ The settings file follows the ``ini`` fo
     eslint = lint -l eslint
 
     [build]
     telemetry = true
 
     [try]
     default = fuzzy
 
-.. _Adding_mach_to_your_shell:
-
-Adding ``mach`` to your ``PATH``
---------------------------------
-
-If you don't like having to type ``./mach``, you can add your source directory
-to your ``PATH``. DO NOT copy the script to a directory already in your
-``PATH``.
-
 
 .. _bash completion: https://searchfox.org/mozilla-central/source/python/mach/bash-completion.sh