summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-12-06 19:11:00 -0500
committerRichard Lowe <richlowe@richlowe.net>2011-12-06 19:11:00 -0500
commit02d343801942cd35a00f725715a5284cc331de31 (patch)
treebcf10f74bf5d181afc9682d1cb5b050291576d39
parent54e1b875d4d795a51276a4439ef32d49fc342e73 (diff)
downloadillumos-joyent-02d343801942cd35a00f725715a5284cc331de31.tar.gz
webrev: Document how git determines parenthood, and what it accepts
We made git function fundamentally differently, in terms of the webrev "parent". Document (to the best degree I can). - That the parent is the branch this branch is tracking, or origin/master - That a specified parent is anything at all that git accepts as a tree, including reflog entries, etc, etc.
-rw-r--r--usr/src/tools/scripts/webrev.19
1 files changed, 8 insertions, 1 deletions
diff --git a/usr/src/tools/scripts/webrev.1 b/usr/src/tools/scripts/webrev.1
index f121753af5..b0cf41080e 100644
--- a/usr/src/tools/scripts/webrev.1
+++ b/usr/src/tools/scripts/webrev.1
@@ -181,7 +181,14 @@ from the
In the case of Git \fBwebrev\fR will attempt to use the output from the
.BR git (1)
"git rev-parse --git-dir" command to identify the workspace root, and will
-treat 'origin/master' as the workspace parent.
+attempt to use the remote branch which the current branch is tracking as the
+parent, if none is specified 'origin/master' will be used.
+
+The parent specified when git is, in all cases, a git 'tree-ish' and never an
+actual git repository, remote or otherwise. Anything specifiable to git as a
+tree-ish should, similarly, be specifiable as a parent for webrev. This
+includes branches, explicit revisions, reflog entries, etc. See
+.BR git-rev-parse (1)
.SS Subversion
In the case of Subversion \fBwebrev\fR will attempt to use the output