diff options
Diffstat (limited to 'tools/tools/git/git-arc.1')
| -rw-r--r-- | tools/tools/git/git-arc.1 | 41 |
1 files changed, 31 insertions, 10 deletions
diff --git a/tools/tools/git/git-arc.1 b/tools/tools/git/git-arc.1 index e449875c5043..a056a2223e0e 100644 --- a/tools/tools/git/git-arc.1 +++ b/tools/tools/git/git-arc.1 @@ -24,11 +24,11 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd May 5, 2023 +.Dd Janurary 15, 2025 .Dt GIT-ARC 1 .Os .Sh NAME -.Nm git arc +.Nm "git arc" .Nd a wrapper to improve integration between git and arcanist .Sh SYNOPSIS .Nm @@ -50,6 +50,7 @@ .Op Ar commit ... Ns | Ns Ar commit-range .Nm .Cm update +.Op Fl l .Op Fl m Ar message .Op Ar commit ... Ns | Ns Ar commit-range .Sh DESCRIPTION @@ -58,8 +59,11 @@ The utility creates and manages .Fx Phabricator reviews based on git commits. +It requires the +.Pa devel/arcanist +port or package. .Pp -Git +.Nm assumes a one-to-one relationship between git commits and Differential Revisions, and the Differential Revision title must match the summary line of the corresponding commit. @@ -72,19 +76,21 @@ The available verbs are: .It Cm create Create new Differential Revisions from the specified commits. Accepts options: -.Bl -tag -width subscriber +.Bl -tag -width "-s subscriber" .It Fl l Before processing commit(s) display list of commits to be processed and wait for confirmation. .It Fl r Ar reviewer Add one or more reviewers, separated by commas, to revision(s) being created. -Argument(s) must be existing Phabricator user or group. +Each argument must be an existing Phabricator user or group. +Note that group reviewers must be specified using their +hashtag (e.g. #jails for the "Jails" group). .It Fl s Ar subscriber Add one or more subscribers, separated by commas, to revision(s) being created. Each argument must be an existing Phabricator user or group. .It Fl p Ar parent Specify the parent of the first commit in the list. -This is useful when adding more commits on top of the already existing +This is useful when adding more commits on top of an already existing stack in Phabricator. .El .It Cm list @@ -117,6 +123,11 @@ each revision. If an empty message is supplied via .Fl m , then no notes will be added when updating Differential Revisions. +.Pp +If +.Fl l +is used, display list of commits to be updated and wait for confirmation +of the list rather than prompting for each commit. .El .Sh CONFIGURATION These are manipulated by @@ -138,9 +149,9 @@ Defaults to false. Always use .Dq list mode .Pq Fl l -with create. -In this mode, the list of git revisions to create reviews for -is listed with a single prompt before creating reviews. +with create and update. +In this mode, the list of git revisions to use +is listed with a single prompt before creating or updating reviews. The diffs for individual commits are not shown. Defaults to false. .It Va arc.verbose @@ -176,13 +187,16 @@ $ git push freebsd HEAD:main Create a Phabricator review using the contents of the most recent commit in your git checkout: .Bd -literal -offset indent -$ git arc create -r markj HEAD +$ git arc create -r markj,#jails HEAD .Ed .Pp The commit title is used as the review title, the commit log message is used as the review description, and .Aq Mt markj@FreeBSD.org is added as a reviewer. +Also, the +.Dq Jails +reviewer group is added using its hashtag. .Pp Create a series of Phabricator reviews for each of HEAD~2, HEAD~ and HEAD: @@ -227,6 +241,13 @@ List the status of reviews for all the commits in the branch .Bd -literal -offset indent $ git arc list main..feature .Ed +.Pp +Update reviews for all commits in the branch +.Dq feature +after rebasing: +.Bd -literal -offset indent +$ git arc update -lm "Rebase" main..feature +.Ed .Sh SEE ALSO .Xr build 7 , .Xr development 7 |