Page MenuHomeFreeBSD
Differential D33031 Diff 98680 tools/tools/git/git-arc.1

Changeset View

Standalone View

View Options

tools/tools/git/git-arc.1

Show All 18 Lines
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd May 14, 2021 .Dd November 17, 2021
.Dt GIT-ARC 1 .Dt GIT-ARC 1
.Os .Os
.Sh NAME .Sh NAME
.Nm git arc .Nm git arc
.Nd a wrapper to improve integration betwen git and arcanist .Nd a wrapper to improve integration betwen git and arcanist
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Cm create .Cm create
.Op Fl l .Op Fl l
.Op Fl r Ar reviewer1 Ns Op Cm \&, Ns Ar reviewer2 ... .Op Fl r Ar reviewer1 Ns Op Cm \&, Ns Ar reviewer2 ...
.Op Fl s Ar subscriber1 Ns Op Cm \&, Ns Ar subscriber2 ... .Op Fl s Ar subscriber1 Ns Op Cm \&, Ns Ar subscriber2 ...
.Op Fl p Ar parent
pauamma_gundo.comUnsubmitted
Not Done
Inline Actions

Unlike reviewer* and subscriber*, I have no idea what parent is for or why/when/how to use it. Since not all contributors will be able to read the actual wrapper well enough to figure it, it needs elaboration.

pauamma_gundo.com: Unlike reviewer* and subscriber*, I have no idea what parent is for or why/when/how to use it.
markjUnsubmitted
Not Done
Inline Actions

Indeed, I'd write "parent revision" at least. And a sentence or two of exposition would be good as well.

markj: Indeed, I'd write "parent revision" at least. And a sentence or two of exposition would be good…
debdrupUnsubmitted
Not Done
Inline Actions

Unlike reviewer* and subscriber*, I have no idea what parent is for or why/when/how to use it. Since not all contributors will be able to read the actual wrapper well enough to figure it, it needs elaboration.

The syntax should at the very least show if it's only possible to have one parent, or if there can be more - the mdoc can optionally be copied almost verbatum from the above examples if that's the case, or I can assist with creating markup for if there's only one parent, if requested.

debdrup: > Unlike reviewer* and subscriber*, I have no idea what parent is for or why/when/how to use it.
glebiusAuthorUnsubmitted
Done
Inline Actions

There can be only one parent specified. What would be proper mandoc for that? Thanks

glebius: There can be only one parent specified. What would be proper mandoc for that? Thanks
.Op Ar commit Ns | Ns Ar commit-range .Op Ar commit Ns | Ns Ar commit-range
.Nm .Nm
.Cm list Ar commit Ns | Ns Ar commit-range .Cm list Ar commit Ns | Ns Ar commit-range
.Nm .Nm
.Cm patch Ar diff1 Ns Op Cm \&, Ns Ar diff2 .Cm patch Ar diff1 Ns Op Cm \&, Ns Ar diff2
.Nm .Nm
.Cm stage .Cm stage
.Op Fl b Ar branch .Op Fl b Ar branch
Show All 26 Lines
Before processing commit(s) display list of commits to be processed Before processing commit(s) display list of commits to be processed
and wait for confirmation. and wait for confirmation.
.It Fl r Ar reviewer .It Fl r Ar reviewer
Add one or more reviewers, separated by commas, to revision(s) being created. Add one or more reviewers, separated by commas, to revision(s) being created.
Argument(s) must be existing Phabricator user or group. Argument(s) must be existing Phabricator user or group.
.It Fl r Ar subscriber .It Fl r Ar subscriber
Add one or more subscribers, separated by commas, to revision(s) being created. Add one or more subscribers, separated by commas, to revision(s) being created.
Argument(s) must be existing Phabricator user or group. Argument(s) must be existing Phabricator user or group.
.It Fl p Ar parent
Specify the parent of the first commit in the list.
pauamma_gundo.comUnsubmitted
Done
Inline Actions
.It Fl p Ar parent
- Specify parent of the first commit in the list.
- Useful when adding more commits on top of the already existing
+ Specify the parent of the first commit in the list.
+ This is useful when adding more commits on top of the already existing
stack in Phabricator.
pauamma_gundo.com:
This is useful when adding more commits on top of the already existing
stack in Phabricator.
.El .El
.It Cm list .It Cm list
Print the associated Differential Revisions for the specified commits. Print the associated Differential Revisions for the specified commits.
.It Cm patch .It Cm patch
Try to apply a patch from a Differential revision to the currently Try to apply a patch from a Differential revision to the currently
checked out tree. checked out tree.
.It Cm stage .It Cm stage
Prepare a series of commits to be pushed to the upstream Prepare a series of commits to be pushed to the upstream
Show All 38 Lines
The diffs for individual commits are not shown. The diffs for individual commits are not shown.
Defaults to false. Defaults to false.
.It Va arc.verbose .It Va arc.verbose
Always use verbose output. Always use verbose output.
Equivalent to the Equivalent to the
.Fl v .Fl v
flag. flag.
Defaults to false. Defaults to false.
.El .El
impUnsubmitted
Not Done
Inline Actions

I'd add a .Pp here and explain about parent here. It wouldn't hurt to explain about subscriber and reviewer too, since those are also not explained.

imp: I'd add a .Pp here and explain about parent here. It wouldn't hurt to explain about subscriber…
.Sh EXAMPLES .Sh EXAMPLES
The typical end-to-end usage looks something like this. The typical end-to-end usage looks something like this.
.Pp .Pp
Commit changes with a message and create a Differential review: Commit changes with a message and create a Differential review:
.Bd -literal -offset indent .Bd -literal -offset indent
$ git commit -m "kern: Rewrite in Rust" $ git commit -m "kern: Rewrite in Rust"
$ git arc create HEAD $ git arc create HEAD
.Ed .Ed
▲ Show 20 Lines • Show All 71 Lines • Show Last 20 Lines