Author: ptw
Date: 2007-08-31 14:22:29 -0700 (Fri, 31 Aug 2007)
New Revision: 6308
Modified:
tools/trunk/svn/README.txt
tools/trunk/svn/svn-bash.sh
Log:
Change 20070831-ptw-l by [EMAIL PROTECTED] on 2007-08-31 10:56:38 EDT
in /Users/ptw/OpenLaszlo/tools
for http://svn.openlaszlo.org/tools
Summary: Include instructions on updating Jira when committing
Technical Reviewer: [EMAIL PROTECTED] (pending)
QA Reviewer: ben (Message-Id: <[EMAIL PROTECTED]>)
Details:
Implement Andr?\195?\169's suggestion
Modified: tools/trunk/svn/README.txt
===================================================================
--- tools/trunk/svn/README.txt 2007-08-31 21:20:24 UTC (rev 6307)
+++ tools/trunk/svn/README.txt 2007-08-31 21:22:29 UTC (rev 6308)
@@ -1,6 +1,6 @@
How to use subversion for OpenLaszlo collaborative development
author: benjamin shine [EMAIL PROTECTED]
-last modified: 2007-03-21 by ptw
+last modified: 2007-08-31 by ptw
copyright: 2006-2007
SYNOPSIS:
@@ -34,32 +34,34 @@
% svn-editchange
-This will start a new change description (or resume an existing one, if you
-already have one started), and invoke $EDITOR to edit it. You should
-fill in the change template details. You should nominate reviewers in
-the change template. You can elide any sections that are not
-applicable.
+This will start a new change description (or resume an existing one,
+if you already have one started), and invoke $EDITOR to edit it. You
+should fill in the change template details. You should nominate
+reviewers in the change template. Please elide any sections that are
+not applicable.
[NOTE: The list of files in the change text is taken from what svn
believes is modified at the time you first invoke `svn-editchange`.
+This list of files will be used to drive the remainder of the change
+process.
+
If you add, modify, or revert files after starting your change, you
-will need to update the file list by invoking:
+MUST update the file list by invoking:
% svn-updatechange
which will update the file list and then invoke your editor on the
-updated change description.
-]
+updated change description.]
5. When you are happy with your change text, invoke
% svn-review
This will check your change in to svn so that your reviewer can
-retrieve it and review it. On OS X, it will compose a mail message
-addressed to your reviewers. On other platforms it will output the
-message to standard out; you can pipe it to your favorite mailer, or
-copy and paste.
+retrieve it and review it. On OS X and Cygwin, it will compose a mail
+message addressed to your reviewers. On other platforms it will
+output the message to standard out; you can pipe it to your favorite
+mailer, or copy and paste.
6. The reviewer can approve or reject your change. In either case
they may offer comments. For an approved change, addressing the
@@ -68,14 +70,30 @@
7. You can update your change text by invoking
+% svn-updatechange
+
+If you have not modified, added or removed any files in addressing the
+review comments, it will be faster to use
+
% svn-editchange
-Make sure your reviewer information is accurate.
+which only edits the change text, without querying svn.
+Make sure your reviewer information is accurate. It can be helpful to
+include a comment after the reviewers name containing the mail
+Message-ID for the reviewer's approval, or if approval is given some
+other way to note that.
+
8. To submit your change, invoke
% svn-commit
+9. Finally, update any Jira entries for bugs that are fixed by your
+change. Note the svn revision number from svn-commit. Run svn log -v
+-r<revision number> and paste the output into Jira as the comment when
+resolving the bug. Also update the Fixed in Change# field with your
+svn <revision number>.
+
DETAILS
Change descriptions in progress are stored in $SVNCHANGES. If you do not
@@ -118,6 +136,7 @@
Note that this command checks your change in as a proposed change to the
patches
directory, for the purposes of review; it does not check in your code to the
source tree itself.
+
On the mac, this will open a message in Mail. On other platforms, it
will echo the change on standard out, which you can pipe to your mail
program of choice, or cut and paste (or dig into the code and make
@@ -129,6 +148,9 @@
$ tar xvf $PATCH_NAME
$ $PATCH_NAME/apply.sh
+(Note that the apply.sh technology is weak. It is sometimes better to
+simply untar the $PATCH_NAME/files.tar into your directory.)
+
To back out a change you applied, either
$ svn-unapplychangepackage
which is really just "apply this patch in reverse", equivalent to
Modified: tools/trunk/svn/svn-bash.sh
===================================================================
--- tools/trunk/svn/svn-bash.sh 2007-08-31 21:20:24 UTC (rev 6307)
+++ tools/trunk/svn/svn-bash.sh 2007-08-31 21:22:29 UTC (rev 6308)
@@ -162,6 +162,13 @@
sed -e '1,/^Files:/d' -e 's/^[A-Z +]\{6\} *//' < "${change}" >
"${files}"
sed -e '/^Files:/,$d' < "${change}" > "${message}"
svn ci --file "${message}" --username "${USER}" --password
"${SVNPASSWD}" --targets "${files}" && \
+ (echo 1>&2; \
+ printf \
+"Remember to update any Jira entries for bugs that are fixed by your\n\
+change. Note the svn revision number above. Run svn log -v\n\
+-r<revision number> and paste the output into Jira as the comment when\n\
+resolving the bug. Also update the Fixed in Change# field with your\n\
+svn <revision number>." 1>&2) && \
rm -r "${changedir}"
else
echo "$changename inaccessible"
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
