aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuss Cox <rsc@swtch.com>2014-11-16 21:39:05 -0500
committerRuss Cox <rsc@swtch.com>2014-11-16 21:48:16 -0500
commit0edb04685bfac6ba0373398f3e9ee561dbaae6bf (patch)
tree55f73849b1e3c092ba846273cc5e6601e9e461fd
parent294f22a4705f221b9f5cf0d8df0dc7cf7626b886 (diff)
downloadplan9port-0edb04685bfac6ba0373398f3e9ee561dbaae6bf.tar.gz
plan9port-0edb04685bfac6ba0373398f3e9ee561dbaae6bf.tar.bz2
plan9port-0edb04685bfac6ba0373398f3e9ee561dbaae6bf.zip
codereview: make commit -a the default; warn about uncommitted changes at upload
also update README.md for github Change-Id: I7d578a902ffed7f6d69780721e29a1972b6f6992
-rw-r--r--README.md29
-rwxr-xr-xbin/codereview8
-rw-r--r--man/man1/codereview.126
3 files changed, 38 insertions, 25 deletions
diff --git a/README.md b/README.md
index 8cec190c..9f3af587 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
This is a port of many Plan 9 libraries and programs to Unix.
-* Installation
+Installation
+------------
To install, run ./INSTALL. It builds mk and then uses mk to
run the rest of the installation.
@@ -8,7 +9,8 @@ run the rest of the installation.
For more details, see install(1), at install.txt in this directory
and at http://swtch.com/plan9port/man/man1/install.html.
-* Documentation
+Documentation
+-------------
See http://swtch.com/plan9port/man/ for more documentation.
(Documentation is also in this tree, but you need to run
@@ -17,21 +19,28 @@ a successful install first. After that, "9 man 1 intro".)
Intro(1) contains a list of man pages that describe new features
or differences from Plan 9.
-* Helping out
+Helping out
+-----------
If you'd like to help out, great! The TODO file contains a small list.
If you port this code to other architectures, please share your changes
so others can benefit.
-Please use diff -u or CVS (see below) to prepare patches.
+Please use codereview(1) to prepare patches.
-* CVS
+Git
+---
-You can use CVS to keep your local copy up-to-date as we make
-changes and fix bugs. See the cvs(1) man page here ("9 man cvs")
-for details on using cvs.
+You can use Git to keep your local copy up-to-date as we make
+changes and fix bugs. See the git(1) man page here ("9 man git")
+for details on using Git.
-* Contact
+Contact
+-------
-Russ Cox <rsc@swtch.com>
+* Mailing list: http://groups.google.com/group/plan9port-dev
+* Issue tracker: http://code.swtch.com/plan9port/issues/
+* Submitting changes: http://swtch.com/go/codereview
+
+* Russ Cox <rsc@swtch.com>
diff --git a/bin/codereview b/bin/codereview
index 6fd3e11a..6606a5c6 100755
--- a/bin/codereview
+++ b/bin/codereview
@@ -59,7 +59,7 @@ case create
if($show) {
echo '% git branch '$branch' && git commit || git branch -d '$branch >[1=2]
}
- git branch $branch && git checkout $branch && git commit $* || git branch -d $branch
+ git branch $branch && git checkout $branch && git commit -a $* || git branch -d $branch
case commit
shift
@@ -72,7 +72,7 @@ case commit
$git commit $*
exit $status
}
- $git commit --amend $*
+ $git commit --amend -a $*
exit $status
case upload
@@ -88,6 +88,10 @@ case upload
if(! 9 grep 'machine plan9port-review.googlesource.com' $HOME/.netrc >/dev/null >[2=1]) {
echo 'codereview: warning: cannot find plan9port-review in netrc' >[1=2]
}
+ if(! git status | 9 grep 'nothing to commit, working directory clean' >/dev/null) {
+ echo 'codereview: warning: local changes not yet committed' >[1=2]
+ git status
+ }
$git push https://plan9port-review.googlesource.com/plan9 HEAD:refs/for/master >[2=1] | 9 sed 's/.* //'
case sync
diff --git a/man/man1/codereview.1 b/man/man1/codereview.1
index 0b713c45..ec528b22 100644
--- a/man/man1/codereview.1
+++ b/man/man1/codereview.1
@@ -13,18 +13,12 @@ codereview \- review of submitted changes (experimental)
]
.B create
.I name
-[
-.B -a
-]
.PP
.B codereview
[
.B -v
]
.B commit
-[
-.B -a
-]
.PP
.B codereview
[
@@ -60,6 +54,10 @@ and then commits them to a ``feature branch''
using
.I codereview
.IR create .
+Once a feature branch is created, files can still be edited, but they must then be
+incorporated into the change by using
+.I codereview
+.IR commit .
.I Git
requires that changes be added to a ``staging area'' before the initial commit,
using commands such as
@@ -69,16 +67,18 @@ and
.I git
.IR rm .
The
-.B -a
-option causes
.I codereview
.I create
-to add all local modifications to the staging area as part of the initial commit.
-.PP
-Once a feature branch is created, files can still be edited, but they must then be
-incorporated into the change by using
+and
.I codereview
-.IR commit .
+.I commit
+commands
+automatically move all local modifications to the staging area
+as part of the commit,
+using
+.I git
+.I commit
+.IR -a .
.PP
If other changes have been committed since the feature branch was created,
.I codereview