Differential D25007 Diff 23 src/docs/user/userguide/arcanist_diff.diviner

Changeset View

Standalone View

src/docs/user/userguide/arcanist_diff.diviner

@title Arcanist User Guide: arc diff		@title Arcanist User Guide: arc diff
@group userguide		@group userguide

Guide to running `arc diff`, to send changes to Differential for review.		Guide to running `arc diff`, to send changes to Differential for review.

This article assumes you have `arc` installed and running; if not, see		This article assumes you have `arc` installed and running; if not, see
@{article:Arcanist User Guide} for help getting it set up.		@{article:Arcanist User Guide} for help getting it set up.

Before running `arc diff`, you should create a `.arcconfig` file. If someone		Before running `arc diff`, you should create a `.arcconfig` file. If someone
set things up for you, they may already have done this. See		set things up for you, they may already have done this. See
@{article:Arcanist User Guide: Configuring a New Project} for instructions and		@{article:Arcanist User Guide: Configuring a New Project} for instructions and
information.		information.

= Overview =		= Overview =

While `arc` has a large number of commands that interface with various		While `arc` has a large number of commands that interface with various
Phabricator applications, the primary use of `arc` is to send changes for		Phorge applications, the primary use of `arc` is to send changes for
review in Differential (for more information on Differential, see		review in Differential (for more information on Differential, see
@{article:Differential User Guide}). If you aren't familiar with Differential,		@{article:Differential User Guide}). If you aren't familiar with Differential,
it may be instructive to read that article first to understand the big picture		it may be instructive to read that article first to understand the big picture
of how the code review workflow works.		of how the code review workflow works.

You send changes for review by running `arc diff`. The rest of this document		You send changes for review by running `arc diff`. The rest of this document
explains how to use `arc diff`, and how the entire review workflow operates for		explains how to use `arc diff`, and how the entire review workflow operates for
different version control systems.		different version control systems.
▲ Show 20 Lines • Show All 136 Lines • ▼ Show 20 Lines	- `arc commit`: Works in Subversion. Runs `svn commit` with a detailed commit
message.		message.
- `arc close-revision`: Works anywhere, closes a revision from the CLI		- `arc close-revision`: Works anywhere, closes a revision from the CLI
without going through the web UI.		without going through the web UI.

You can use `arc help <command>` for detailed help with any of these.		You can use `arc help <command>` for detailed help with any of these.
Differential will make a guess about a next step on accepted revisions, but it		Differential will make a guess about a next step on accepted revisions, but it
may not be the best next step for your workflow.		may not be the best next step for your workflow.

Phabricator will also automatically close revisions if the changes are pushed		Phorge will also automatically close revisions if the changes are pushed
to a repository that is tracked in Diffusion. Specifically, it will close		to a repository that is tracked in Diffusion. Specifically, it will close
revisions based on commit and tree hashes, and `Differential Revision`		revisions based on commit and tree hashes, and `Differential Revision`
identifiers in commit messages.		identifiers in commit messages.

If you push to an untracked repository (or `arc` can't figure out that it's		If you push to an untracked repository (or `arc` can't figure out that it's
tracked), `arc land`, `arc amend` and `arc commit` will implicitly run		tracked), `arc land`, `arc amend` and `arc commit` will implicitly run
`arc close-revision`.		`arc close-revision`.

Show All 30 Lines