From 4c8de92255f34cb0fbd042d62267e2c1e5c48d05 Mon Sep 17 00:00:00 2001
From: Tim Giles <tgiles@mozilla.com>
Date: Wed, 2 Oct 2024 14:56:16 +0000
Subject: [PATCH] Bug 1921556 - Add Git vcs args snippet to sections that use
 bootstrap.py r=sylvestre DONTBUILD

This will clarify when to use the `--vcs=git` argument during the setup
process to prevent people from accidentally setting up their repository
for Mercurial.

Differential Revision: https://phabricator.services.mozilla.com/D224259
---
 docs/contributing/contribution_quickref.rst | 15 +++++++++++++++
 docs/setup/linux_build.rst                  |  5 +++++
 docs/setup/macos_build.rst                  |  5 +++++
 docs/setup/windows_build.rst                |  5 +++++
 4 files changed, 30 insertions(+)

diff --git a/docs/contributing/contribution_quickref.rst b/docs/contributing/contribution_quickref.rst
index 9a9e5240e943..121a9a0b167f 100644
--- a/docs/contributing/contribution_quickref.rst
+++ b/docs/contributing/contribution_quickref.rst
@@ -55,6 +55,11 @@ To Setup Firefox On Windows
     $ mkdir mozilla-source
     $ cd mozilla-source
     $ wget https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py
+
+    # To use Git as your VCS
+    $ python3 bootstrap.py --vcs=git
+
+    # To use Mercurial as your VCS
     $ python3 bootstrap.py
 
 More information on :ref:`building Firefox for Windows <Building Firefox On Windows>`.
@@ -65,6 +70,11 @@ To Setup Firefox On macOS and Linux
 .. code-block:: shell
 
     $ curl https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py -O
+
+    # To use Git as your VCS
+    $ python3 bootstrap.py --vcs=git
+
+    # To use Mercurial as your VCS
     $ python3 bootstrap.py
 
 More information on :ref:`building Firefox for Linux <Building Firefox On Linux>` and :ref:`building Firefox for MacOS <Building Firefox On MacOS>`.
@@ -75,6 +85,11 @@ To Setup Firefox for Android
 .. code-block:: shell
 
     $ curl https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py -O
+
+    # To use Git as your VCS
+    $ python3 bootstrap.py --vcs=git
+
+    # To use Mercurial as your VCS
     $ python3 bootstrap.py
 
 More information on :ref:`building Firefox for Android <Firefox for Android>`
diff --git a/docs/setup/linux_build.rst b/docs/setup/linux_build.rst
index 8d5ed8937371..8ef3b568cf96 100644
--- a/docs/setup/linux_build.rst
+++ b/docs/setup/linux_build.rst
@@ -94,6 +94,11 @@ the interactive setup process.
 .. code-block:: shell
 
     curl https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py -O
+
+    # To use Git as your VCS
+    python3 bootstrap.py --vcs=git
+
+    # To use Mercurial as your VCS
     python3 bootstrap.py
 
 .. note::
diff --git a/docs/setup/macos_build.rst b/docs/setup/macos_build.rst
index b4a0a136ea64..603e26ff1c7f 100644
--- a/docs/setup/macos_build.rst
+++ b/docs/setup/macos_build.rst
@@ -74,6 +74,11 @@ the interactive setup process.
 .. code-block:: shell
 
     curl https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py -O
+
+    # To use Git as your VCS
+    python3 bootstrap.py --vcs=git
+
+    # To use Mercurial as your VCS
     python3 bootstrap.py
 
 .. note::
diff --git a/docs/setup/windows_build.rst b/docs/setup/windows_build.rst
index 7dfc5f3da1c5..452035b3fd12 100644
--- a/docs/setup/windows_build.rst
+++ b/docs/setup/windows_build.rst
@@ -75,6 +75,11 @@ the interactive setup process.
     mkdir mozilla-source
     cd mozilla-source
     wget https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py
+
+    # To use Git as your VCS
+    python3 bootstrap.py --vcs=git
+
+    # To use Mercurial as your VCS
     python3 bootstrap.py
 .. note::