Skip to content

Commit

Permalink
Add section on commit series.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Cote committed Aug 24, 2017
1 parent a050dc8 commit 7d395e2
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
Binary file added images/add-child-revision.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/revision-stack.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions phabricator-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ title. Finally, you will also see a few actions on the revision,
which are automatically performed by our BMO-integration code. For
more on Phabricator-BMO integration, see :ref:`bmo-integration`.

.. _fix-up-commits:

Fix-Up Commits
--------------

Expand Down Expand Up @@ -257,6 +259,42 @@ single entry. The "History" tab, however, is identical to the fix-up
commits scenario, with "Diff 1" and "Diff 2" entries, and the same
ability to see the different patches and differences between them.

Series of Commits
-----------------

It is possible to chain a series of revisions together in Differential,
although it is currently a manual process. Each revision can have one
or more parents and one or more children. This feature can be used to
represent a stack of commits to split up a complicated patch, which is
a good practice to make testing and review easier.

To use this pattern, you will need to specify the exact commit you
want to send to Differential, since the default is to send all your
draft commits to a single revision, i.e. the :ref:`fix-up-commits`
method, which is not what we want here. To send the currently
checked-out commit, run ``arc diff .^``.

To set the parent-child relationship, go to your first commit, choose
"Edit Related Revisions..." from the right-hand menu, then "Edit Child
Revisions". Your child revision may be suggested, or you can enter
an ID into the search box, including the ``D`` to denote a
differential revision, e.g. ``D32``:

.. image:: images/add-child-revision.png
:align: center
:alt: Screenshot of the dialog for adding a child revision

Select the appropriate revision and click "Save Child Revisions". The
"Revision Contents" table will now have a new tab, "Stack", which
shows the current stack of revisions:

.. image:: images/revision-stack.png
:align: center
:alt: Screenshot of a revision stack

Unfortunately there is not currently a way to see a combined diff of
all the stacked commits together without applying the commits locally.

****************
Our Installation
****************
Expand Down

0 comments on commit 7d395e2

Please sign in to comment.