Skip to content

Commit

Permalink
Highlight that moz-phab has better handling for commit-message parsing.
Browse files Browse the repository at this point in the history
Summary:
This is a separate revision to avoid having to make too many changes
to the Arcanist User Guide when it was split from the Phabricator
User Guide.

Depends on D3242.

Reviewers: glob

Reviewed By: glob

Differential Revision: https://phabricator.services.mozilla.com/D3260
  • Loading branch information
Mark Côté committed Aug 14, 2018
1 parent d13e3ce commit 1e74932
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 17 deletions.
23 changes: 14 additions & 9 deletions arcanist-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ Mozilla's `Engineering Workflow
<https://wiki.mozilla.org/Engineering_Workflow>`_ team has created a
custom command-line tool, :ref:`moz-phab <using-moz-phab>`, which has
better support for submitting, updating, and applying series of
commits. This document is an older guide for Arcanist, the official
upstream command-line interface to Phabricator. It may still be
useful for those who do not frequently submit patches for review, or
who rarely author nor review series of commits.
commits. It also has conveniences for parsing bug IDs and reviewers
from commit-message summaries or specifying them as command-line
options.

This document is an older guide for Arcanist, the official upstream
command-line interface to Phabricator. It may still be useful for
those who do not frequently submit patches for review.

This guide is a quick overview of how to submit, update, and apply
patches with Arcanist. The official Phabricator documentation also
Expand Down Expand Up @@ -90,13 +93,14 @@ in the commit message under most circumstances.
Unfortunately, a limitation of Phabricator currently prevents us from
seeding this field with a bug ID from the commit message (at least
from the first line, where bug IDs are usually mentioned in
mozilla-central changesets); however, we will be able to work around
this in our upcoming `custom command-line interface
<https://wiki.mozilla.org/Engineering_Workflow/Road_Map#Better_support_for_commit_series_in_Phabricator_and_Lando>`_.
mozilla-central changesets). Note that we have worked around these
restrictions in :ref:`moz-phab <using-moz-phab>`.

You may want to add a reviewer, which should be a Phabricator username
(e.g. ``mcote``). You can also add one or more subscribers, who will
be notified of updates to the revision.
be notified of updates to the revision. Again, we cannot parse these
out of the commit summary with Arcanist, but :ref:`moz-phab
<using-moz-phab>` supports this.

Note that the commits to be included in this revision are present in
the comment at the bottom of the text. You can use this to double-check
Expand Down Expand Up @@ -245,7 +249,8 @@ The relationship will be created when ``arc diff`` is run.
Unfortunately there is not currently a way to see a combined diff of
all the stacked commits together without applying the commits
locally. Also, when you update any commits, you'll need to run ``arc
diff .^`` for each child commit as well.
diff .^`` for each child commit as well. This was the primary purpose of
writing :ref:`moz-phab <using-moz-phab>`.

See also this `blog post
<https://smacleod.ca/posts/commit-series-with-phabricator/>`_ on
Expand Down
17 changes: 9 additions & 8 deletions phabricator-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ available.

We have also created a custom command-line tool, `moz-phab
<https://github.com/mozilla-conduit/review>`_, which is a wrapper
around Arcanist, providing better support for submitting series of
commits than Arcanist does by itself.
around Arcanist, providing several conveniences, including better
support for submitting series of commits than Arcanist does by itself.

.. _quick-start:

Expand Down Expand Up @@ -152,9 +152,10 @@ Using moz-phab
--------------

moz-phab is a custom command-line tool that improves on Arcanist's
limited support for commit series. We recommend using it if you
regularly construct stacks of dependent changesets, or even if you
regularly review them.
limited support for commit series, as well as providing other
conveniences, including the parsing of bug IDs and reviewers from
commit messages. We recommend using it if you regularly construct
stacks of dependent changesets, or even if you regularly review them.

Installation and usage instructions are in the repository's `README.md
<https://github.com/mozilla-conduit/review/blob/master/README.md>`_.
Expand All @@ -166,9 +167,9 @@ for details.
Using Arcanist
--------------

If you only sporadically submit code for review, or you rarely work
with series of commits, you may want to use Arcanist. We have a short
:doc:`user guide </arcanist-user>` available.
If you only sporadically submit code for review, you may want to use
Arcanist. We have a short :doc:`user guide </arcanist-user>`
available.

.. _reviewing-patches:

Expand Down

0 comments on commit 1e74932

Please sign in to comment.