Skip to content

Commit

Permalink
Bug 1735747 - Use mozilla-unified as mercurial bundle document exampl…
Browse files Browse the repository at this point in the history
…e. r=sylvestre

Differential Revision: https://phabricator.services.mozilla.com/D128464
  • Loading branch information
arai-a committed Oct 14, 2021
1 parent a90dd56 commit d3871de
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/contributing/vcs/mercurial_bundles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Mercurial Bundles

If you have a poor network connection that is preventing ``hg clone`` from completing, you may want to try downloading a bundle of the repository you're interested in. This is useful since a file download, unlike ``hg clone``, can be resumed if the connection is interrupted. Once you have the bundle, staying up-to-date shouldn't take much time at all, if you keep up with it regularly.

This document explains the steps to setup the `mozilla-central <https://hg.mozilla.org/mozilla-central/>`__ repository using a bundle file. Be sure to replace "``mozilla-central``" with the project you're working with as appropriate.
This document explains the steps to setup the `mozilla-unified <https://hg.mozilla.org/mozilla-unified/>`__ repository using a bundle file. Be sure to replace "``mozilla-unified``" with the project you're working with as appropriate.

Download the bundle
-------------------
Expand All @@ -13,29 +13,29 @@ Download the bundle
It lists up-to-date bundles for some of the repositories listed at https://hg.mozilla.net/ .
Each row corresponds to each repository, and each column corresponds to each compression format.

2. Download the bundle file for the ``mozilla-central`` repository:
2. Download the bundle file for the ``mozilla-unified`` repository:

Click the link in the "mozilla-central" row, the "zstd (max)" column.
Click the link in the "mozilla-unified" row, the "zstd (max)" column.

Setting up the repository
-------------------------

Once you have downloaded the repository bundle, follow the steps below to recreate the repository locally based upon that bundle.

1. Initialize a new repository (in a directory called ``mozilla-central`` here):
1. Initialize a new repository (in a directory called ``mozilla-unified`` here):

.. code-block:: shell
mkdir mozilla-central
hg init mozilla-central
mkdir mozilla-unified
hg init mozilla-unified
2. Un-bundle the bundle file to that repository:

Move the bundle file next to ``mozilla-central`` directory, and rename it to ``bundle.hg``.
Move the bundle file next to ``mozilla-unified`` directory, and rename it to ``bundle.hg``.

.. code-block:: shell
cd mozilla-central
cd mozilla-unified
hg unbundle ../bundle.hg
Get comfortable. Grab a coffee (or your favorite tasty beverage). Maybe a nap. This unbundling process is going to take quite a lot of time.
Expand All @@ -45,7 +45,7 @@ Get comfortable. Grab a coffee (or your favorite tasty beverage). Maybe a nap. T
.. code-block:: shell
[paths]
default = https://hg.mozilla.org/mozilla-central/
default = https://hg.mozilla.org/mozilla-unified/
4. Update the repository to get all the changes since the bundle was created (this step also doubles as a check of the bundle integrity since if its contents are not exactly the same as what's in the official repository then the ``hg pull`` will fail):

Expand All @@ -59,7 +59,7 @@ Get comfortable. Grab a coffee (or your favorite tasty beverage). Maybe a nap. T
hg update
You now have a clone of ``mozilla-central`` that is identical to one made via ``hg clone``. You can adjust your build settings, or you can go straight ahead and build Firefox!
You now have a clone of ``mozilla-unified`` that is identical to one made via ``hg clone``. You can adjust your build settings, or you can go straight ahead and build Firefox!

If at any point you are stuck, feel free to ask on Riot/Matrix at `https://chat.mozilla.org <https://chat.mozilla.org>`__
in `#introduction <https://chat.mozilla.org/#/room/#introduction:mozilla.org>`__ channel.

0 comments on commit d3871de

Please sign in to comment.