docs: refactor Mercurial docs into a doc tree
authorGregory Szorc <gps@mozilla.com>
Tue, 28 Oct 2014 21:52:18 -0700
changeset 359835 13a3f68d07d6bc57b133117105a200844021c9dd
parent 359834 7f22c9f346893c71201e3ea6cca89a7f30c82357
child 359836 54387132cf0ba618457118ba2da5e7f402de6bab
push id16998
push userrwood@mozilla.com
push dateMon, 02 May 2016 19:42:03 +0000
docs: refactor Mercurial docs into a doc tree
README.rst
docs/hgcustom.rst
docs/hgext.rst
docs/hghooks.rst
docs/index.rst
--- a/README.rst
+++ b/README.rst
@@ -4,104 +4,8 @@ Mozilla Version Control Tools
 
 This repository contains tools, extensions, hooks, etc to support version
 control at Mozilla.
 
 This repository contains the code that Mozilla uses in production to
 power ``hg.mozilla.org``.
 
 The canonical repository is https://hg.mozilla.org/hgcustom/version-control-tools/
-
-Mercurial Extensions
-====================
-
-This repository contains a number of Mercurial extensions. Each is
-described in the sections below.
-
-All extensions are located under the ``hgext/`` subdirectory.
-
-bundleclone
------------
-
-The bundleclone extension is an experiment extension that allows
-Mercurial servers to advertise where pre-generated bundles may be
-fetched from. When ``hg clone`` is performed, the client will fetch a
-static bundle file then do an incremental ``hg pull``. This is much more
-efficient for the server.
-
-bzexport
---------
-
-The bzexport extension provides commands for interacting with Bugzilla.
-It's known for its namesake ``hg bzexport`` command, which exports/uploads
-patches to Bugzilla. It also offers an ``hg newbug`` command to create
-new bugs from the command line.
-
-This extension lives under ``hgext/bzexport``.
-
-bzpost
-------
-
-The bzpost extension will automatically update Bugzilla after pushing
-changesets that reference bugs.
-
-firefoxtree
------------
-
-The firefoxtree extension makes working with the various Firefox
-repositories much more pleasant.
-
-mozext
-------
-
-*mozext* is a Swiss Army Knife for Firefox development. It provides a
-number of features:
-
-* It defines aliases for known Firefox repositories. You can do
-  ``hg pull central``, etc.
-* It provides a mechanism for tracking each repository via bookmarks,
-  allowing you to more easily operate a unified repository.
-* Changes to Python files are automatically checked for style.
-* Pushlog data is synchronized to a local database.
-* Bug data is extracted from commit messages and stored in a database.
-* Many revision set and template functions are added.
-
-If you are looking to turn Mercurial into a more powerful query tool or
-want to maintain a unified repository, *mozext* is very valuable.
-
-This extension lives under ``hgext/mozext``.
-
-pushlog-legacy
---------------
-
-This is a collection of code that modifies Mercurial to support
-recording when and who pushes to repositories.
-
-qbackout
---------
-
-The qbackout extension provides assitance to help perform code backouts
-the Mozilla way.
-
-qimportbz
----------
-
-The qimportbz extension allows you to easily import patches from
-Bugzilla.
-
-reviewboard
------------
-
-The reviewboard extension provides a Mozilla-centric workflow for
-performing code review with ReviewBoard and Bugzilla.
-
-serverlog
----------
-
-The serverlog extension hacks up some Mercurial internals to record
-forensics that are useful for Mercurial server operators.
-
-Hooks
-=====
-
-The hghooks directory contains various Mercurial hooks. The content of
-this directory originally derived from its own repository. Changesets
-e11fee681380 through 1f927bcba52c contain the import of this repository.
new file mode 100644
--- /dev/null
+++ b/docs/hgcustom.rst
@@ -0,0 +1,14 @@
+.. _hgcustom:
+
+========================
+Mercurial Customizations
+========================
+
+This repository contains numerous customizations to the
+`Mercurial <http://mercurial.selenic.com/>`_ version control tool.
+
+.. toctree::
+   :maxdepth: 2
+
+   hgext
+   hghooks
copy from README.rst
copy to docs/hgext.rst
--- a/README.rst
+++ b/docs/hgext.rst
@@ -1,32 +1,22 @@
-=============================
-Mozilla Version Control Tools
-=============================
-
-This repository contains tools, extensions, hooks, etc to support version
-control at Mozilla.
-
-This repository contains the code that Mozilla uses in production to
-power ``hg.mozilla.org``.
-
-The canonical repository is https://hg.mozilla.org/hgcustom/version-control-tools/
+.. _hgext:
 
 Mercurial Extensions
 ====================
 
 This repository contains a number of Mercurial extensions. Each is
 described in the sections below.
 
 All extensions are located under the ``hgext/`` subdirectory.
 
 bundleclone
 -----------
 
-The bundleclone extension is an experiment extension that allows
+The bundleclone extension is an **experimental** extension that allows
 Mercurial servers to advertise where pre-generated bundles may be
 fetched from. When ``hg clone`` is performed, the client will fetch a
 static bundle file then do an incremental ``hg pull``. This is much more
 efficient for the server.
 
 bzexport
 --------
 
@@ -35,18 +25,20 @@ It's known for its namesake ``hg bzexpor
 patches to Bugzilla. It also offers an ``hg newbug`` command to create
 new bugs from the command line.
 
 This extension lives under ``hgext/bzexport``.
 
 bzpost
 ------
 
-The bzpost extension will automatically update Bugzilla after pushing
-changesets that reference bugs.
+The bzpost extension will automatically update Bugzilla with comments
+containing the URL to pushed changesets after pushing changesets that
+reference bugs. The implementation is highly tailored towards the
+Firefox workflow.
 
 firefoxtree
 -----------
 
 The firefoxtree extension makes working with the various Firefox
 repositories much more pleasant.
 
 mozext
@@ -88,20 +80,16 @@ The qimportbz extension allows you to ea
 Bugzilla.
 
 reviewboard
 -----------
 
 The reviewboard extension provides a Mozilla-centric workflow for
 performing code review with ReviewBoard and Bugzilla.
 
+This extension is a component of :ref:`MozReview <mozreview>`, Mozilla's
+code review service.
+
 serverlog
 ---------
 
 The serverlog extension hacks up some Mercurial internals to record
 forensics that are useful for Mercurial server operators.
-
-Hooks
-=====
-
-The hghooks directory contains various Mercurial hooks. The content of
-this directory originally derived from its own repository. Changesets
-e11fee681380 through 1f927bcba52c contain the import of this repository.
new file mode 100644
--- /dev/null
+++ b/docs/hghooks.rst
@@ -0,0 +1,16 @@
+.. _hghooks:
+
+===============
+Mercurial Hooks
+===============
+
+The ``hghooks`` directory contains a number of Mercurial hooks used by
+Mozilla projects.
+
+The content of this directory originally derived from its own
+repository. Changesets ``e11fee681380`` through ``1f927bcba52c`` contain
+the import of this repository.
+
+This directory has its origins in the operation of the Mercurial server
+at Mozilla. It is an eventual goal to restructure the hooks to be usable
+on both client and server.
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,16 +3,17 @@
 Mozilla's Version Control Tools
 ===============================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   hgcustom
    mozreview
    hacking-mozreview
    headless-repositories
    testing
 
 
 
 Indices and tables