If more than one file needs to be removed, you need to perfom the svn remove operation for each file one after another. (You can't remove several files from the repository at the same time in one line.)

==Helpful svn commands==

==Helpful svn commands==

Line 71:

Line 88:

Will tell you that to commit changes, you do "svn commit [path] --message "<reasoning>"

Will tell you that to commit changes, you do "svn commit [path] --message "<reasoning>"

-

== Adding a new file to the repository ==

-

How to add a file (not for creating new folders in the svn repository):

-

<pre>

-

svn add <filename>

-

svn commit -m "This new file will do something useful" <filename>

-

</pre>

-

You can add more than one file at a time:

-

<pre>

-

svn add <filename1> <filename2> <filenameN>

-

svn commit -m "These new files work together to add some extra functionality" <filename1> <filename2> <filenameN>

-

</pre>

-

-

==Deleting a file from the repository==

-

To remove a file from the repository, you need to give it the url of the file in the repository:

If more than one file needs to be removed, you need to perfom the svn remove operation for each file one after another. (You can't remove several files from the repository at the same time in one line.)

Basic SVN commands

Checking out projects

You need to know the urls of the components you want to checkout. Then you would either of the following

svn checkout url

svn co url

The above will check it all out into a default folder name. For instance:

svn checkout http://svn.greenstone.org/greenstone3/trunk

will check out Greenstone 3 into a folder called trunk in the current directory.

You can alternatively provide an optional folder name at the end of the command, to check the contents out into:

svn checkout http://svn.greenstone.org/greenstone3/trunk greenstone3

This will check out Greenstone 3 into a folder called greenstone3.

svn update and revert

An svn update merges the repository's changes with the local changed code, or shows places where conflicts have arisen (conflicts are shown with a C next to the files you tried to update). If someone else had committed changes to the repository and if these did not conflict with the changes in your own version, the svn update would show up a "G", not a "C". To deal with conflicts (C), see a later section.

To update the local file(s) with just the changes made in the repository, do an "svn update":

> svn update <filename1> <filename2> ... <filenameN>

To overwrite local file(s) with the one in the repository, do an "svn revert"--you would do this if you want to go back to the version of the file in the repository (you will lose all changes you had made since the last commit):

> svn revert <filename1> ... <filenameN>

You can update an entire directory (and subdirectories) by moving into that directory and typing:

> svn update

svn diff

Note that svn diff does not connect to the repository! It compares your file against the file you had downloaded, not the file as it exists at the moment in the svn repository.

Committing files

Perform an svn diff it to look over the changes made since you last updated the file. Then svn update the file, perform the svn diff on the updated file, then svn commit it with a message:

> svn diff <filename>

Will show you the changes you've made since you last did an svn update on the file.

> svn update <filename>

It will merge changes made to the file in the repository with the changes you have on your machine. Your own changes take precedence and these are preserved. However, conflicts may arise if any of the lines that have been modified on your machine have been changed in the repository since you last checked it out/svn-updated it.

> svn diff <filename>

This diff now shows up the differences between your current file and what's there now in the repository. Check that only the new code you have added is the sum total of the differences.

> svn commit - m "message" <filename>

Where the message string is one that explains what changes have been made, why you are committing the file or what purpose a new file serves.

To perform these svn operations on more more than 1 file in one go, separate them by spaces:

Deleting a file from the repository

Aliases for svn remove are "svn delete" and "svn rm".
If more than one file needs to be removed, you need to perfom the svn remove operation for each file one after another. (You can't remove several files from the repository at the same time in one line.)

Helpful svn commands

> svn info

> svn switch

> svn status

If you do an "svn status" in a folder, it recursively lists all the Modified (M), Deleted (D) and Added (A) files. It will also show up files that are in conflict (C) and those about which svn does not know (?).
To see what modifications were made to individual files marked with an M, you'd do an "svn diff":

> svn diff <filename>

> svn help
> svn help [item]
eg. svn help status

The last gives instructions on how to use an svn command.
For example:

> svn help commit

Will tell you that to commit changes, you do "svn commit [path] --message "<reasoning>"

Conflicts and resolving them

When doing an "svn status" of a folder you find that any files marked with a C then it means such files are in conflict with their corresponding versions in the svn repository.

Doing an "svn update" may indicate files are in conflict as well. If you performed an "svn update" on a file (or on a folder) and one or more came up with the status C then you have a conflict. It means that changes to the same file on the same lines had been committed to the svn repository as what you have been working on. The update could not successfully merge the corresponding lines as it didn't know which lines to keep and which to overwrite: the lines are in conflict.

If you ever encounter a file in conflict and you view it in an editor, you will see that conflicted lines will be marked with ===== and >>>>. Both the changes you made and the conflicting changes in the repository will be embedded inside such special marks.
(If you had done an "svn update" on files that turned out to conflict, the action would have created a couple of additional versions of the file: conflict-filename.mine and conflict-filename.<revisionnumber>. The first is your local version containing the changes you made. The second is the file as it is in the svn repository.)

To resolve conflicts in a file marked with a C

Open up the file that's in conflict in an editor.

Search for all occurrences of >>> or ===. Each occurrence marks a conflicted section and needs to be resolved.

Deal with marked sections as appropriate: decide which parts you want to keep, which should be removed or how to combine (the best of) both.

Once you've finished editing out the conflicts in the file, you have to set the file's status to resolved for it to be up to date (and updateable with svn):

svn resolved <filename>

If you now try svn update on the file, it should no longer be marked as being in conflict.

Special SVN operations

svn log and annotate

- To find out the list of changes made to code in a file:

>svn annotate <filename>

The above will list the code changes with NUMBERS in front of each line. For example,

svn annotate GathererProg.java | less

To find the message added into the log for making a change

>svn log <filename>

That will give all the messages for all the code changes. For example,

svn log GathererProg.java | less

Or, if you know the specific line of change for which you want to understand the reasoning or view the log message:

>svn log -rNUMBER <filename>

For example:

svn log -r10242 GathererProg.java

Creating a new project in the svn repository

You'd do this if you want to put your program, stored only on your machine at the moment, onto the svn repository.

The program folder on your harddrive, called "my_program" for instance, may contain:

That will put your folder and its contents into the svn repository inside a similarly named folder.
Now, we need to check out our own svn-managed copy:
Move up out of the local my_program directory and make a back-up copy of original program folder, just in case:

3. cd ..
4. mv my_program my_program.bak

Finally, checkout the a copy of the program from the svn repository, that will be stored on your machine in my_program:

5. svn co http://svn.greenstone.org/other-projects/trunk/my_program

Your program folder is just as before, except that it's now managed with svn.

Copying an older revision of a file or folder back into the current svn revision

If you've accidentally deleted an svn repository folder, such as "my_program", and want to bring it back (the older version is, after all, stored in the svn repository):

Comparing versions: comparing current folder contents with contents of an older revision:

/my/local/path>svn diff -r {2008-04-26} .

b. Checking out an older revision of Greenstone 3 is a special situation. For this you would do:

ant <target> -Dbranch.revision=<number>

eg. ant prepare -Dbranch.revision=15190

This will do an ant prepare/ant install/ant command using the revision number specified. Usually, you'd want to do an "ant prepare" with the revision flag. (And thereafter compile your greenstone 3 up again with a normal "ant install".)

Changing an svn property

You may want to do this if a regular text file in the svn repository is marked as a binary file and therefore won't let you do an "svn diff" to compare the text contents.