r76 | fbos | 2007-01-31 12:28:22 -0500 (mer., 31 janv. 2007) | 1 line
Reformatted README slightly, added mention of switch subcommand.
git-svn-id: svn+ssh://rubyforge.org/var/svn/piston/trunk@82 d6c2ea82-c31b-0410-8381-e9c44f9824c5
| |   |
| 1 | | Piston is a utility that enables merge tracking of remote repositories. |
| 1 | Piston is a utility that eases vendor branch management. |
| 2 | 2 | This is similar to <tt>svn:externals</tt>, except you have a local copy of |
| 3 | 3 | the files, which you can modify at will. As long as the changes are |
| 4 | 4 | mergeable, you should have no problems. |
| … | … | |
| 7 | 7 | contrib/client-side folder of the main Subversion repository at |
| 8 | 8 | http://svn.collab.net/repos/svn/trunk/contrib/client-side/svnmerge.py. |
| 9 | 9 | The main difference is that Piston is designed to work with remote |
| 10 | | repositories. Another tool you might want to look at, SVK, situated at |
| 11 | | http://svk.elixus.org. |
| 10 | repositories. Another tool you might want to look at, SVK, which you can find |
| 11 | at http://svk.elixus.org/. |
| 12 | 12 | |
| 13 | 13 | From Wikipedia's Piston page (http://en.wikipedia.org/wiki/Piston): |
| 14 | 14 | In general, a piston is a sliding plug that fits closely inside the bore |
| … | … | |
| 21 | 21 | inside the cylinder." Piston forces the content of a remote repository |
| 22 | 22 | location back into our own. |
| 23 | 23 | |
| 24 | |
| 24 | 25 | = Installation |
| 25 | 26 | |
| 26 | 27 | Nothing could be simpler: |
| … | … | |
| 56 | 56 | $ piston unlock vendor/rails |
| 57 | 57 | 'vendor/rails' unlocked. |
| 58 | 58 | |
| 59 | If the branch you are following moves, you should use the switch subcommand: |
| 60 | |
| 61 | $ piston import http://dev.rubyonrails.org/svn/rails/branches/1-2-pre-release vendor/rails |
| 62 | $ svn commit vendor/rails |
| 63 | |
| 64 | # Vendor branch is renamed, let's follow it |
| 65 | $ piston switch http://dev.rubyonrails.org/svn/rails/branches/1-2-stable vendor/rails |
| 66 | |
| 59 | 67 | |
| 60 | 68 | = Contributions |
| 61 | 69 | |
| … | … | |
| 130 | 130 | Piston depends on the following libraries: |
| 131 | 131 | |
| 132 | 132 | * yaml |
| 133 | | * getoptlong |
| 134 | 133 | * uri |
| 135 | 134 | * fileutils |
| 136 | | |
| 137 | | These dependencies are all included in a stock 1.8.4 Ruby distribution. |
| toggle raw diff |
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-Piston is a utility that enables merge tracking of remote repositories.
+Piston is a utility that eases vendor branch management.
This is similar to <tt>svn:externals</tt>, except you have a local copy of
the files, which you can modify at will. As long as the changes are
mergeable, you should have no problems.
@@ -7,8 +7,8 @@ This tool has a similar purpose than svnmerge.py which you can find in the
contrib/client-side folder of the main Subversion repository at
http://svn.collab.net/repos/svn/trunk/contrib/client-side/svnmerge.py.
The main difference is that Piston is designed to work with remote
-repositories. Another tool you might want to look at, SVK, situated at
-http://svk.elixus.org.
+repositories. Another tool you might want to look at, SVK, which you can find
+at http://svk.elixus.org/.
From Wikipedia's Piston page (http://en.wikipedia.org/wiki/Piston):
In general, a piston is a sliding plug that fits closely inside the bore
@@ -21,6 +21,7 @@ For this utility, I retain the second meaning, "to exert a force on a fluid
inside the cylinder." Piston forces the content of a remote repository
location back into our own.
+
= Installation
Nothing could be simpler:
@@ -55,6 +56,14 @@ When you want to update again, you unlock:
$ piston unlock vendor/rails
'vendor/rails' unlocked.
+If the branch you are following moves, you should use the switch subcommand:
+
+ $ piston import http://dev.rubyonrails.org/svn/rails/branches/1-2-pre-release vendor/rails
+ $ svn commit vendor/rails
+
+ # Vendor branch is renamed, let's follow it
+ $ piston switch http://dev.rubyonrails.org/svn/rails/branches/1-2-stable vendor/rails
+
= Contributions
@@ -121,8 +130,5 @@ repository than the one we checked out from originally.
Piston depends on the following libraries:
* yaml
-* getoptlong
* uri
* fileutils
-
-These dependencies are all included in a stock 1.8.4 Ruby distribution. |