Page MenuHomeFreeBSD

git-arc.1: Clarify argument format for group reviewers
ClosedPublic

Authored by bnovkov on Apr 8 2025, 5:27 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Sep 27, 3:22 AM
Unknown Object (File)
Fri, Sep 26, 8:22 AM
Unknown Object (File)
Wed, Sep 24, 2:03 AM
Unknown Object (File)
Sep 15 2025, 2:15 PM
Unknown Object (File)
Sep 7 2025, 8:16 PM
Unknown Object (File)
Sep 6 2025, 3:33 PM
Unknown Object (File)
Sep 4 2025, 3:58 AM
Unknown Object (File)
Aug 13 2025, 9:53 PM

Details

Summary

Note that '-r' expects a hashtag instead of a group name.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

tools/tools/git/git-arc.1
87

Hashtag is from social media and kind of slang. How do you feel about:
"Group reviewers must be prefixed with a number sign
.Pq Ql # ,
e.g. Jails"

Addl. Context: https://en.m.wikipedia.org/wiki/Number_sign

Maybe we don't even have to bloat it at all and could make it clear by simply saying:
"Each argument must be an existing Phabricator user or #group."

tools/tools/git/git-arc.1
87

I opted for "hashtag" since it was already used in one of the examples below, IMO it makes the expected format very clear.

tools/tools/git/git-arc.1
85–88

Adding a sentence and a parenthetical does make it clear, but it adds a lot of complexity. Would it be clear if we improved the first sentence instead, without adding complexity?

tools/tools/git/git-arc.1
85–88

I think this is fine. A larger improvement would be to sync the usage message and man page, which give similar but not identical content and examples.

This revision is now accepted and ready to land.Apr 10 2025, 4:03 PM