2 .\" SPDX-License-Identifier: BSD-2-Clause
4 .\" Copyright (c) 2021 Daniel Ebdrup Jensen
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd a wrapper to improve integration between git and arcanist
37 .Op Fl r Ar reviewer1 Ns Op Cm \&, Ns Ar reviewer2 ...
38 .Op Fl s Ar subscriber1 Ns Op Cm \&, Ns Ar subscriber2 ...
40 .Op Ar commit ... Ns | Ns Ar commit-range
42 .Cm list Ar commit ... Ns | Ns Ar commit-range
44 .Cm patch Ar diff1 Ns Op Cm \&, Ns Ar diff2
48 .Op Ar commit ... Ns | Ns Ar commit-range
52 .Op Ar commit ... Ns | Ns Ar commit-range
56 utility creates and manages
58 Phabricator reviews based on git commits.
61 assumes a one-to-one relationship between git commits and
62 Differential Revisions, and the Differential Revision title must match
63 the summary line of the corresponding commit.
64 In particular, the commit summaries must be unique across all open
65 Differential Revisions authored by the submitter.
67 The first parameter must be a verb.
68 The available verbs are:
69 .Bl -tag -width "create"
71 Create new Differential Revisions from the specified commits.
73 .Bl -tag -width subscriber
75 Before processing commit(s) display list of commits to be processed
76 and wait for confirmation.
78 Add one or more reviewers, separated by commas, to revision(s) being created.
79 Argument(s) must be existing Phabricator user or group.
80 .It Fl s Ar subscriber
81 Add one or more subscribers, separated by commas, to revision(s) being created.
82 Each argument must be an existing Phabricator user or group.
84 Specify the parent of the first commit in the list.
85 This is useful when adding more commits on top of the already existing
89 Print the associated Differential Revisions for the specified commits.
91 Try to apply a patch from a Differential Revision to the currently
94 Prepare a series of commits to be pushed to the upstream
97 The commits are cherry-picked to a branch (by default the
99 branch), review tags are added to the commit log message, and
100 the log message is opened in an editor for any last-minute
102 The commits need not have associated Differential
105 Synchronize the Differential Revisions associated with the
107 Currently only the diff is updated; the review description and other
108 metadata are not synchronized.
109 If a message is specified with
111 that message is added as a note to the Differential Revision.
112 If no message is supplied,
113 the user's editor will be opened to provide an update message for
115 If an empty message is supplied via
117 then no notes will be added when updating Differential Revisions.
120 These are manipulated by
122 .Bl -tag -width "arc.assume_yes"
123 .It Va arc.assume_yes
126 answer to all prompts instead of
133 Try to open newly created reviews in a browser tab.
140 In this mode, the list of git revisions to create reviews for
141 is listed with a single prompt before creating reviews.
142 The diffs for individual commits are not shown.
145 Always use verbose output.
152 The typical end-to-end usage looks something like this.
154 Commit changes with a message and create a Differential Review:
155 .Bd -literal -offset indent
156 $ git commit -m "kern: Rewrite in Rust"
157 $ git arc create HEAD
160 Make changes to the diff based on review feedback, then amend the
161 changes to the existing commit and update the Differential Review:
162 .Bd -literal -offset indent
164 $ git arc update HEAD
167 Now that all reviewers are happy, it is time to stage the commit and
169 .Bd -literal -offset indent
171 $ git push freebsd HEAD:main
174 Create a Phabricator review using the contents of the most recent
175 commit in your git checkout:
176 .Bd -literal -offset indent
177 $ git arc create -r markj HEAD
180 The commit title is used as the review title, the commit log
181 message is used as the review description, and
182 .Aq Mt markj@FreeBSD.org
183 is added as a reviewer.
185 Create a series of Phabricator reviews for each of HEAD~2, HEAD~ and
187 .Bd -literal -offset indent
188 $ git arc create HEAD~3..HEAD
191 Pairs of consecutive commits are linked into a patch stack.
192 Note that the first commit in the specified range is excluded.
194 Create a series of separate reviews for each of the following commits:
195 .Bd -literal -offset indent
196 $ git arc create b409afcfedcdda ca03ed1345aff0
199 Update the review corresponding to commit b409afcfedcdda:
200 .Bd -literal -offset indent
201 $ git arc update b409afcfedcdda
204 The title of the commit must be the same as it was when the review
206 Note that the review description is not automatically updated.
208 Apply the patch in review D12345 to the currently checked-out tree,
210 .Bd -literal -offset indent
211 $ git arc patch D12345
214 List the status of reviews for all the commits in the branch
216 .Bd -literal -offset indent
217 $ git arc list main..feature
225 utility appeared in the src tools collection in
230 utility was written by
232 .An Mark Johnston Aq Mt markj@FreeBSD.org
233 and the manual page was written by
234 .An Daniel Ebdrup Jensen Aq Mt debdrup@FreeBSD.org .