Difference between revisions of "OnlineHelp:Contents"

From RapidSVN
Jump to navigation Jump to search
Line 17: Line 17:
 
=== User Interface ===
 
=== User Interface ===
 
=== Basic Concepts ===
 
=== Basic Concepts ===
 +
 +
==Setting preferences==
 +
* Click on the menu item 'View/Preferences...' to set the preferences.
 +
===Programs===
 +
 +
The 'Programs' tab must be filled with the paths pointing to the programs that perform Edit, Explore and Diff functions.
 +
 +
Under [[Installation on Windows|Windows]] the suggested programs are:
 +
{| border="1" cellspacing="0" cellpadding="5"
 +
! Function !! Program      !! Options
 +
|-
 +
| Editor  || notepad.exe  || 
 +
|-
 +
| Explorer || explorer.exe || 
 +
|-
 +
| Diff    || '''???'''    || 
 +
|} <!-- PLEASE HELP ME !!! I have no idea on the program and the parms that need to be set for the Diff function... I tried DIFF3.EXE from the WinCVS directory but I get no result (wima) -->
  
 
== Tutorial ==
 
== Tutorial ==
 +
 
If you are new to both Subversion and RapidSVN, probably the first thing you are trying to do is checkout a working copy of an existing repository.
 
If you are new to both Subversion and RapidSVN, probably the first thing you are trying to do is checkout a working copy of an existing repository.
  

Revision as of 09:05, 31 May 2007

Introduction

As you can see, the user documentation for RapidSVN has just started. The first draft with the outline was created 2006-11-01 and it will grow in the weeks and months (and years!) to come.

Your help with the documentation is requested! If you want to proofread the texts or if you want to create whole sections of the documentation: just create an account and start working on the site.

In the past I had to disable the user account creation to the public after this was abused by wiki spammers who would come and insert invisible SPAM links in our pages (probably to get a better google pagerank). Hopefully this won't be that much of an issue anymore, since now a user has to verify her account.

Installation

Windows

  1. Download the installer package for windows operating system from here.
  2. Double click on it to start the installation process.
  3. Follow the steps that you see on the screen, you can leave the default options.
  4. You are done, now you need some SVN repository to start working!.

Mac OS/X

Linux/Unix

User Interface

Basic Concepts

Setting preferences

  • Click on the menu item 'View/Preferences...' to set the preferences.

Programs

The 'Programs' tab must be filled with the paths pointing to the programs that perform Edit, Explore and Diff functions.

Under Windows the suggested programs are:

Function Program Options
Editor notepad.exe  
Explorer explorer.exe  
Diff ???  

Tutorial

If you are new to both Subversion and RapidSVN, probably the first thing you are trying to do is checkout a working copy of an existing repository.

Checkout a Working Copy

  1. Click on the 'Repository' menu
  2. Click on the menu item 'Checkout.. (CTRL-O)', this will open the 'Checkout' dialog box
  3. Enter the URL of the Subversion repository in the 'URL Text box'
  4. Select a local directory for your sandbox (working copy)
  5. Click the 'OK' button

If you are new to RapidSVN, but have used Subversion, probably the first thing you want to do is view an existing Subversion sandbox with RapidSVN.

View an existing subversion sandbox (working copy) with RapidSVN

  1. Right click 'Bookmarks'
  2. Click 'Add Existing Working Copy'
  3. Browse for the root of the local copy
  4. Click the 'OK' button

Create a new Repository

At the present state a repository can only created with the command svnadmin. to do so just type in svnadmin create file:///path/to/repository

Import into the Repository

Browse the Repository

Review your Changes

Commit your Changes

  1. Ensure that the view 'Flat Mode' is enabled.
  2. Highlight any new files and do an 'Add' (Control+a).
  3. Highlight any changed and recently added files and do a Commit (Control + m).
  4. Enter a meaningful? comment, and select OK.

Update your Working Copy

Create a Tag / Branch

Branching and tagging are both achieved by using RapidSVN's Copy command (Modify > Copy, or press F5). Copy the directories and files you wish to branch / tag into a subdirectory of your relevant branch or tag folder. Note that you will need to type the full address (i.e. starting with svn://) into the "Select Destination:" box.

Merging

Merging is combining the contents of one branch with another, or combining one branch with your trunk (main) version. This is accomplished via the Repository > Merge... option. An important thing to know about merging is that you merge the versions on your local machine, not on the remote repository.

In brief, the steps are as follows. Assumming you want to merge branch1 and branch2,

  1. Update your local copy of branch1 from the repository
  2. Update your local copy of branch2 from the repository
  3. Select Merge... from the Repository menu
  4. In the "First working copy or URL", enter the local address of branch1
  5. In the "Second working copy or URL", enter the local address of branch2
  6. Enter revisions in the two "Revision" boxes (see below).
  7. In "Destination path", enter the local address of the folder you'd like your merge to be created in
  8. Click OK
  9. Select the lkocation where your merge has been placed and Commit it to the remote repository (use Ctrl-M, the toolbar icon, or Modify > Commit).

If you are merging a branch with a trunk (main) version, you may wish to have "Second working copy or URL" and "Destination path" both be the path to your main version.

"Revision" cannot be left blank. You are also unable to type "head". If you wish to use your head (latest) version, you will need to type in its number. This can be discovered by selecting your remote repository in Bookmarks (you can't do this while the Merge dialog is open) and selecting "Log..." from the "Query" menu. Use the Revision number from the latest entry in the log (top of the list).


Export from the Repository

Exporting from a repository allow you to copy the contents of a repository without the SubVersion (SVN) inforration. Essentially, it gives you a clean version of the files.

To export from a repository:

1. Click on "Repository" and choose "Export..."

2. In the "URL" box, type the URL of the repository you wish to export. You don't have to export the whole respository, you can export individual files or directories if you wish.

3. In The "Destination Directory", type the path to the location you wish to export to.

4. Click "OK"

Troubleshooting

Getting support

A good place to ask questions about RapidSVN is the users' mailinglist at mailto:users@rapidsvn.tigris.org.

The mailinglist central is at http://rapidsvn.tigris.org/servlets/ProjectMailingListList. You can use this page to search for messages that may address your problem.

The RapidSVN project uses an issue tracker to manage bugs/defects or feature requests. The URL for the issue tracker is http://rapidsvn.tigris.org/servlets/ProjectIssues. Please ask your questions / report your problem first on the mailinglist to keep duplicate entries in the issue tracker at a minimum.

I've sized a file list heading to zero and can no longer see it

(all)

You can also reset all columns to their default widths and selections from the View->Columns->Reset Columns menu pick.

(Windows)

  1. Quit RapidSVN
  2. Run regedit
  3. Navigate to HKEY_CURRENT_USER\Software\RapidSVN\RapidSVN\FileListCtrl
  4. Find parameter names that end in width with their values set to 0
  5. Set the parameter value to something like 50.
  6. Run RapidSVN

Appendix

Glossary

Index