@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
1@title Differential User Guide: FAQ
2@group userguide
3
4Common questions about Differential.
5
6= Why does an "accepted" revision remain accepted when it is updated? =
7
8You can configure this behavior with `differential.sticky-accept`.
9
10When a revision author updates an "Accepted" revision in Differential, the
11state remains "Accepted". This can be confusing if you expect the revision to
12change to "Needs Review" when it is updated.
13
14Although this behavior is configurable, we think stickiness is a good behavior:
15stickiness encourage authors to update revisions when they make minor changes
16after a revision is accepted. For example, a reviewer may accept a change with a
17comment like this:
18
19> Looks great, but can you add some documentation for the foo() function
20> before you land it? I also caught a couple typos, see inlines.
21
22If updating the revision reverted the status to "Needs Review", the author
23is discouraged from updating the revision when they make minor changes because
24they'll have to wait for their reviewer to have a chance to look at it again.
25
26Instead, the "Accepted" state is sticky to encourage them to update the revision
27with a comment like:
28
29> - Added docs.
30> - Fixed typos.
31
32This makes it much easier for the reviewer to go double-check those changes
33later if they want, and the update tells them that the author acknowledged their
34suggestions even if they don't bother to go double-check them.
35
36If an author makes significant changes and wants to get them looked at, they can
37always "request review" of an accepted revision, with a comment like:
38
39> When I was testing my typo fix, I realized I actually had a bug, so I had to
40> make some more changes to the bar() implementation -- can you look them over?
41
42If authors are being jerks about this (making sweeping changes as soon as they
43get an accept), solve the problem socially by telling them to stop being jerks.
44Unless you've configured additional layers of enforcement (by
45using @{article:Herald}), there's nothing stopping them from silently changing
46the code before pushing it, anyway.
47
48
49= How can I enable syntax highlighting? =
50
51You need to install and configure **Pygments** to highlight anything else than
52PHP. See the `pygments.enabled` configuration setting.
53
54= What formatting can be used in comments? =
55
56Phorge implements a markup language similar to other markup languages like
57Markdown and Wiki markup. See @{article:Remarkup Reference}.
58
59= What do the very light green and red backgrounds mean? =
60
61Differential uses these colors to mark changes coming from rebase: they are
62part of the diff but they were not added or removed by the author. They can
63appear in diff of diffs against different bases.
64
65= Next Steps =
66
67Continue by:
68
69 - returning to the @{article:Differential User Guide}.