# The &kdesvn; Handbook

Rajko
Albrecht

    ral@alwins-world.de

2005
2008
Rajko Albrecht
&FDLNotice;
$Date: 2010-01-17 01:38:27 +0100 (So, 17. Jan 2010) $
0.4

&kdesvn; - a subversion client for &kde;.

KDE
kdesvn
subversion
version control system

## Introduction

&kdesvn; is a subversion client for &kde;.

You should have some knowledge about subversion itself, but hopefully most items are self explanatory.

You may send bugreports and feature wishes via http://kdesvn.alwins-world.de/.

### Terms

If you're familiar with revision control systems you may skip that - or read and correct the author ;)

Repository

  Central store of data. That may be a database or a flat filesystem. Without special clients you're not able to read data in it. For Subversion repositories &kdesvn; is such a client.

Working copy

  A flat copy of a repository on local filesystem. This is used like any normal filemanager, editing files and so forth. RCS-information you can read with clients like &kdesvn;.

  Remember that subversion doesn't know something about KIO, so a working copy must reside in an area where it may reached without any specific protocol, eg "fish://" or such isn't possible.

WebDav

  WebDav is a protocol which let you modify files on a remote webserver. Subversion is a special kind of WebDAV when repositories are accessed via webserver. In normal use this is read-only. With special configurations you may get a read-write enabled WebDAV which you may access via specialized browser. &kdesvn; is NOT a webdav-client, but Konqueror is via the "webdav://" protocol. But with &kdesvn; you may browse through the version tree of a repository (via "http://")

## Using &kdesvn;

### &kdesvn; features

&kdesvn; understands following protocols for browsing repositories:

http

  Standard web browser protocol.

https

  Standard encrypted web browser protocol

(k)svn+http

  Standard web browser protocol. May be used to let konqueror automatic call &kdesvn;.

(k)svn+https

  Standard encrypted web browser protocol. May be used to let konqueror automatic call &kdesvn;.

(k)svn+file

  Local repository protocol. May used to let konqueror automatic call &kdesvn;.

(k)svn

  Subversions own server protocol.

(k)svn+ssh

  Subversion over ssh. See FAQ for details about some specials with that protocol.

file

  Direct repository accesss. &kdesvn; checks if a given path is a repository or a working copy and opens it in the right mode. For subversion file:///dir and /dir is not the same!

This list may used for urls given for commandline, too.

### Beginning with subversion and kdesvn

This section is mostly for beginners not familiar with subversion and explains how subversions and/or RCS works.

#### Creating a working copy

Working copies MUST be accessible via local paths. Subversion doesn't know something about pseudo filesystems like smb:// or fish://. &kdesvn; translates some of them if possible (like system:/home) but it isn't possible over a network.

First of all you must create a working copy of your repository. For that select

Subversion General Checkout a repository . Inside the following dialog you must select the URL of the repository you want to use, e.g., something like http://localhost/repos/myproject. Subfolders of a repository are possible, too, e.g., http://localhost/repos/myproject/trunk or similiar.

Select and/or create a local folder, where the working copy should reside.

Last but not least, the revision to checkout. Mostly that should be "HEAD". This ensures that the last stored version is the referenced version.

After clicking on "[OK]" &kdesvn; will create your new working copy and (if the box was checked) opens it.

When you have opened a repository for browsing you may mark a folder and than select Subversion Repository Checkout current repository path . and fill out the dialogs as described above. Then only the marked path will checked out.

#### Commiting local changes

Mark the entry or entries you want to send and select # Subversion Working copy Commit

If you try to commit if no item is selected, &kdesvn; uses the top-most element of opened working copy, eg, the working copy path itself.

This operation is always recursive, means, if selecting a folder &kdesvn; always send all changed items below it. When you setup that you want to review all items before commit inside the following dialog all items kdesvn would send are listed. There you may unmark items you don't want to send. In that case &kdesvn; sends all items alone, eg, not recursive. Or you may select items not versioned for add and commit (if them are not marked to be ignored). So you may see if there are newer items you forgot.

Enter a log message what you're sending and hit "OK" and the transfer starts.

#### Update working copy

This brings you local working copy in sync with the repository. You may setup that &kdesvn; checks on opening a working copy for newer/modified items in repository. This runs in background and you may work meanwhile with &kdesvn;. Or start check with Subversion Working copy Check for updates .

When this is finished, items with newer versions or folders with items where newer items are below are marked.

To retrieve the changes, select Subversion Working copy Update to head . This will update to the most latest version. If you want to get a specific revision select Subversion Working copy Update to revision and select the revision you want in the following box.

If no item is selected, the update will done on whole opened working copy, otherwise only recursive on the selected items.

#### Adding and Deleting from working copy

Both operations requires two steps: First add or delete and then commiting that changes to repository. Before you commit you may undone add or delete.

##### Add items

Adding items into a working copy may be done due three ways:

Select not versioned items and add them

  Copy with konqueror or any other tool into working copy area. Go trough list, mark them and select Insert Subversion Working copy Add selected files/dirs . When you want adding new folders with all subitems select &Ctrl;Insert Subversion Working copy Add selected files/dirs recursive .

Check and add recursive

  You may check if there are somewhere in working copy unversioned items. After selecting Subversion Working copy Check for unversioned items a dialog appears where all not versioned items are listed. Hitting ok adds all marked items to working copy, items you don't want versioned you should unmark before.

Drag and drop

  Mark in konqueror or any other compatible filebrowser items you want to add and drag them to &kdesvn;. You may drop them on folders inside the opened working copy and than &kdesvn; copy the dropped items to it and add the items.

##### Deleting items from working copy and unversion

Deleting items is always recursive. Eg., when you delete a folder all subitems will deleted, too. Mark what you want and select "Delete selected items" from general menu. Items will unversioned and removed from disk.

#### Displaying logs

The log display may start with &Ctrl;L when one or none item is marked in overview. Depending on your settings (see ) &kdesvn; retrieves some log entries beginning on head and displays them.

##### The log display dialog

On left side you see the list of logentries &kdesvn; retrieved. The logmessage is stripped-down to one line to fit. The full logmessage appears in right upper window when marking an entry. In the right lower window you'll the list of changed files. This windows ONLY appears if this list ist fetched depending on your settings.

With the buttons above you may select another range of logs to display.

This range is called without any pre-limit so you have to think about yourself on large repositories.

The buttons below displays always work on item selected for log, not on item selected in list of changed files. So when you select "`Diff previous`" there it makes the diff over all changed items in this revision if them are equivalent or below the subversion entry selected for retrievung logs before. Same for "`Diff revisions`"

"`Annotate`" of course works only if item to log is a file.

On all listentries (both lists) you have context menu enabled for some extra operations. In left list this is "Set version as left side of diff" (eg, beginning revision) and "Set version as right side of diff" (eg., end or target of diff, in unified the part marked with a "`+++`"). If you selected these revisions them are marked with some small arrows.

### Working on repositories

Simple repository browsing may done within &konqi;, &krus; or similar filebrowsers: Open a URL with protocol described in (the variants starting with "k") and them will display the content. So simple operations like copy, move and delete may work. When appending a query "?rev=<xxx>" the listing comes from a specific revision. Format of revision-query is described in , some more information about KIO::ksvn are in

All work except "Copy" may only done when browsing at revision HEAD.

#### Restoring deleted items

In subversion restoring deleted items is a copy operation of item at specific revision. So when you plan restoring view repository at revision before item was deleted. Select Subversion Repository Select browse revision and enter the wanted revision. Now kdesvn displays the content at this term. Mark the entry you want to restore, select C Subversion General Copy . Inside the following dialog the target is always at HEAD revision, the source is at revision you selected for browsing. Fill out the path click "OK" and copy starts. After successfull copy switch browsing back to HEAD revision and the restored item should appear.

#### Importing folders

Due restrictions of subversion itself only folders, not single files, may imported.

##### With drag and drop

Mark in any compatible filemanager the folder you want to import and drag it to the folder entry in &kdesvn; where you want to import it.

##### Select folder to import with directory-browser

Mark the folder where you want to import a new folder. Then select Subversion General Import folders into current and select your wanted folder.

### Other Operations

#### Merge

Open repository or working copy, mark item you want to merge and select Subversion General Merge . Enter in the following dialog the values wanted. If opend from repository, source 1 and source 2 are filled, when open from within working copy, target is filled with current selected item. The handling of this parameter is a little bit different between using the internal diff of subversion or an external merge-programm like kdiff3. The target must ALWAYS a local folder or file. You may switch between external or internal merge with the checkbox "Use external merge".

##### Internal merge

The meaning is exactly like from within subversions own commandline tool. When source1 and source2 are equal, start and endrevision must different. If sources aren't equal, start-revision is assigned to source1 and end-revision to source2. The target MUST be a working copy otherwise subversion will send an error message.

The checkboxes have following meanings:

Recursive

  Do all operations recoursive when working with folders.

Handle unrelated as related items

  If set, unrelated items will be diffed as if they were related. Otherwise subversion will remove one side and add it on other side again.

Force delete on modified/unversioned

  If not set and merge would require deletion of an modified or unversioned item the subversion merge fails. Otherwise this items will deleted.

Just dry run without modifications.

  If set, subversions sends only notifications what it would do but doesn't modify the working copy.

##### Using external program for merge

See for details how to setup the external merge tool. &kappname; generates the commandline as described there. Before it does following:

1. Assign start-revision as revision to source 1 and end-revision to source 2. Then checks if them are different (path and/or revision). If yes, its a three-way merge otherwise a simple merge from source to target. If source 2 is left empty it is a simple merge, too.

2. Make an export into temporary folder. If a simple merge only source1 at start-revision, otherwise both sources with there revisions. If item is a file and not a folder than get the content at a specific revision.

3. Generate the call to your external merge program as you setup in Settings. The error output will displayed in log window so you may see whats going wrong (if something is gone wrong).

In difference to internal merge target may a flat folder/file not under sourcecontrol 'cause external tools doesn't care about it.

If recoursive isn't set, the export is done as a flat export. Be care: when doing this with working copies externals will NOT exported.

#### Resolving conflicts

&kappname; itself hasn't a module for resolving conflicts but you may use external software from within &kappname;. In is a description how to setup up this application.

When marking an item with status set to "conflicted" (you'll see a red cross in listview on such items) you may select Subversion Working copy Resolve conflict . or from within context menu Resolve conflict (only on conflicted items) &kappname; now starts the program you setup (or the default one). After finish this job you should mark item as resolved (Subversion Working copy Mark resolved) otherwise you will not able to commit your changes.

### Properties used by &kappname; for configuration

#### Bugtracker integration

The TortoiseSVN project designed a nice property system for integrating bugtracker into subversion GUI. This moment &kappname; doesn't support extra fields in commit box (will follow later) and doesn't understand all but following properties:

##### Bugtracker Integration Properties

Property | Description | Example
--- | --- | ---
bugtraq:url | Holds the url to bugtracker. It has to contain the %BUGID% marker. | http://kdesvn.alwins-world.de/ticket/%BUGID%

bugtraq:logregex

Contains one or two regular expressions, separated by a newline.

If only one expression is set, then the bare bug ID's must be matched in the groups of the regex string. If two expressions are set, then the first expression is used to find a string which relates to the bug ID but may contain more than just the bug ID (e.g. "Issue #123" or "resolves issue 123"). The second expression is then used to extract the bare bug ID from the string extracted with the first expression.

Please keep care about not wanted spaces after the regular expression and don't forget the brackets around the number description.

Single (useable with TRAC):

    #(\d+)

Now all numbers like #190 will parsed and translated to an url in logoutput.

Two expressions:

    [Ii]ssue #?(\d+)(,? ?#(\d+))*
    (\d+)

Remember: Keep care of white spaces after the (\d+)! This is one of the most errors while this expressions doesn't match!

On local opened repositories (eg., file://-Protocoll) and on working copies this properties will searched upward from opened folder until found or the subversion-toplevel is reached. On repositories opened via network (all except file:// protocoll) it is only searched on opened folder itself.

Support for multiple sets of this properties may follow later, (eg., in subfolder extra values for other tracker etc.) but in most cases evaluatin single tracker links should be enough.

### The revision tree

The revision tree try display the whole history of an item so user may get a bette feeling about the history of an item. It has to scan the complete log of the repository 'cause it requires some information subversion does not (and I think will not) give. 'Cause this produces a lot of traffic the revisiontree uses always the internal logcache.

#### Requirements

The revisiontree is generated via dot. So for a working revisiontree the graphviz package must installed.

### Internal log cache

&kappname; may use an internal logcache for some operations. Mostly it is used for the revisiontree but when viewing simplified log in offline modus, too. The caches are oranized as sqlite databases stored in $HOME/.sqvnqt/logcache. Every numbered file is a storage for a different repository.

The databases may get large! So you may disable automatic update of logcache in settings.

You may simply remove a database, than no cached log will given back for that repository (and no revisiontree!) but when you don't disable automatic filling the cache on next open this repository or an associated working copy of it the cache will refilled again.

#### Offline mode

Kdesvn may work without network access, eg., you may switch that no network access is allowed. This may usefull when working without network like on notebooks. In such cases &kappname; always get the logs from the internal cache. At this time (2008-06-23) this log is reduced to base functions due technical reasons, so the cached log may (but not must) differ from real log. Differ means that it will not display all copy operations even "Log follows nodechanges" is set.

#### Logcache and revisiontree

The revisiontree will only use the logcache 'cause otherwise it must get always the logs again. It will NOT refresh the logcache (but this may changed in later releases).

### Meaning of icon overlays

Entries may be marked with overlayed icons when not in "normal" state.

Locked

  This entry is locked. In last column the owner of lock is listed. You may setup if kdesvn should check for locked items in repository, too. But be carefull: depending of the kind of the server this may take a long time!

Needs locked

  This entry must be locked before edit and commit. Until you'll not set a lock subversion keeps it read-only.

Updates

  This entry or - if a folder - an entry below has newer version in repository. Works only with subversion =>1.2 on local and remote.

Modified

  This entry or - if a folder - an entry below was changed on local disc.

overlay added

  This entry is locally added to subversion but not yet committed.

overlay deleted

  This entry is locally deleted from subversion but hasn't yet been committed.

overlay deleted

  This entry (or entry below if folder) got conflicts to resolve with last update.

### &kappname; and passwords

&kappname;/subversion is able to save passwords. Saving passwords is always a security risk, but may let a graphical frontend more useable.

#### Not saving passwords

Most secure way, but sometimes unhandy with GUIs like &kappname;. In particular the background processes of &kappname; would always ask for a password in case the repository has restricted access for reading operations like update and status. The same for "commit" and so on. So if you not saving passwords you should disable "Check for updates on open working copy" and so on.

#### Saving passwords in kdewallet

Secured password storage used by a lot of kde programs like kmail and konqueror. If you'saving passwords and mostly using kdesvn you should use this. Keep care that the encrypted storage isn't a high-secure storage. Details see kdewallet documentation.

#### Saving to subversions own password storage

This is not recommended 'cause the passwords are stored as cleartext! Not believing? Take a look into the files in ~/.subversion/auth/svn.simple. You should only use this if you're using frequently other clients than &kappname; like rapidsvn or esvn or the original svn commandline client. If you're using the commandline client mostly for checkouts or updates which doesn't require a password and kdesvn for commit/move/copy you should use kdewallet instead.

#### Internal password cache

You may activate an internal password cache which will hold passwords as long &kappname; is running in memory. So you must not enter a password twice even if you didn't save it in wallet.

#### Specialcase svn+ssh

When using subversion via svn+ssh password storage may done via ssh and ssh-agent. For this you must have ssh access to the remote mashine and repository. When want to store you must using the public key authentication of ssh, not the password authentication. (In fact ssh prefer the public key authentication). For this you must put your pulic ssh-key on the target, eg., the repository system. SSH passwords will never handled by subversion passwords storage or kde-wallet or internal password cache.

If you don't want asked for the password of you ssh-key you may use the ssh-agent, with selecting the menu Subversion Add ssh identities to ssh-agent you may store you ssh-key-password for your current session so no further entering of your password is needed.

## Konqueror, KIO, &kappname;

### Description

As of version 0.7.0 of &kappname; it comes with some modules integrating some commands directly into konqueror menus.

KIO protocols

  Implements handlers for following protocols:

  - ksvn+http

  - ksvn+https

  - ksvn+file

  - ksvn+ssh

  - ksvn

  The same maybe for "svn+..." but as from kde 3.4, kdesdk has it own small svn-kio called "svn+http"etc. So packages are organized that way - or should that "svn+..." comes as an extra package so it may installed if kdesdk hasn't installed it.

  These protocols are designed only for repositories, not for working copies. E.g. "ksvn+file:///<path>" must point to the beginning of a repository different to the application itself or KPart. Working copies may browsed with konqueror.

  For browsing at a specific revision you may append the query "?rev=<revision>" to the url.

Context menus

  &kappname; installs context menues for konqueror. Them may be seen with right mouse click in the browser window (only in standard view, not any KPart) so it is possible to do most used actions direct from within konqueror (or any other filemanagers that read konquerors context menues like krusader). This is done via a call to the commandline variant of &kappname;.

  This menu is static up to kde 3.5, so you should care about what you're selecting. Otherwise &kappname; prints an error box.

#### Usage of KIO outside konqueror - an example

Every &kde; based application may use these protocols. So it would be possible to retrieve all differences between two revisions with kdiff3 without any deep knowledge.

##### Retrieving differences between revions using KDiff3 and KIO::ksvn

    kdiff3 \
      ksvn://anonsvn.kde.org/home/kde/trunk/KDE/arts?rev=423127 \
      ksvn://anonsvn.kde.org/home/kde/trunk/KDE/arts?rev=455064

Let kdiff3 print all differences between two revisions. Note! Using this within kdesvn (diff'ing two revisions) is MUCH faster because the internal mechanisms of subversion are used.

### Programmers information about KIO::ksvn

You may skip this if not interested in KIO programming.

KIO::ksvn::special knows the following operations, these are made almost equal in call to the current existing in KIO from kdesdk so, for instance, kdevelop may use it if kdesdk isn't installed but uses kdesvn::KIO::svn.

#### Commandlist

##### Command overview for KIO::ksvn::special

Name/command | Numeric id | Parameter list | Implemented in 0.11.x?
--- | --- | --- | ---
Checkout | 1 | KURL repository, KURL target, int revnumber, QString revkind The target will NOT be modified, e.g., but the content will be checked out without creating a subfolder! e.g., the source may be http://server/repos/project/trunk, target /home/user/proj/ then the contents of trunk will copied into /home/user/proj/ not /home/user/proj/trunk/! | Yes
Update | 2 | KURL url,int revnum, QString revstring If revnum < 0 the revstring is parsed. Format of revstring is described in Appendix. | Yes
Commit | 3 | KURL::List urls urls a list of local urls to commit. Will ask for log. | Yes
Log | 4 | int startrevnumber,QString startrevstring,int endrevnumber,QString endrevstring,KURL::List Use this with care - this may produce a lot of data. | Yes
Import | 5 | KURL targetrepository, KURL sourcepath | Yes
Add | 6 | KURL | Yes
Del | 7 | KURL::List | Yes
Revert | 8 | KURL::List Revert in KIO is always non-recursive, no questions (calling app must do it itself) | Yes
Status | 9 | KURL item,bool checkRepos, bool recurse item - the item check info about, checkRepos - check if there are newer versions in repository, recurse - check recursive or not. | Yes
Mkdir | 10 | KURL::List | Yes
Resolve | 11 | KURL, bool recursive | Yes
Switch | 12 | KURL working_copy_path,KURL new_repository_url,bool recursive,int revnumber, QString revkind | Yes
Diff | 13 | URL uri1, KURL uri2, int r1, QString rstring1, int r2, QString rstring 2, bool recursive For difference between repository file:/// and working copy setup working copy urls without a protocol! | Yes

#### Return values

Return values may given via metadata, see apidoc for details.

##### Content of metadata

Key | Possible value
--- | ---
path | Path of the item action was made on, eg. given url
action | Numeric action type
kind | kind of item (mostly dir or file)
mime_t | Subversion mimetype of item
content | State of content (subversion value)
prop | State of properties (subversion value)
rev | Resulting revision or revision worked on
string | Internal defined human readable message.
loggedaction | Subversion defined action string on item (A,M,D)
loggedcopyfrompath | If copied from which path? (may empty)
loggedcopyfromrevision | If copied at which revision? (may < 0)
loggedpath | On which single path the entries logged action and so on are set. (path is set to the calling url)
diffresult | a line of difference output

## Using kdesvn via commandline

### Overview

Some subversion operations may used via the commandline, eg., like a standard commandline client but user interaction is made via KDE-UI. The standard syntax is kdesvn exec <command> [parameter] <url>.

If a single revision on a single url is wanted it may be set as a parameter of the url

    svn://your-server/path-to-repository/item?rev=<your-rev>

This will overwrite the option -r <rev>.

A revision may given as a number or one of HEAD or BASE or as date format like {YYYY-MM-DD}.

### Commandlist

If in following overview as possible parameter -r revision is given, this revision may set as <url>?rev=the-revision.

#### Subversion commands

Command | Meaning | Accepted options
--- | --- | ---
commit (or ci) | commit changes of item to repository |
log | Print log of item | -r startrevision:endrevision -l limit_display
cat | Display content of item | -r revision
copy (or cp) | Copy item inside working copy or repository. If target isn't given, &kappname; will prompt. |
move (or mv, rename) | Move/Rename item inside working copy or repository. If target isn't given, &kappname; will prompt. |
get | Get content of item and save it | -r revision -o <outputfile> (output is required!)
blame (or annotate) | annotate file | -r startrevision:endrevision
update | Update item in working copy | -r revision
diff | Diff two revisions of item or diff two items at specific revision | -r startrev:endrev
info | Detailed information about the item | -r revision
checkout (or co) | Checkout repository-path into a new working copy path. Target path and source revision will be asked for. |
checkoutto (or coto) | Checkout repository-path into a new working copy path. The difference of the source path and source revision will be asked for. |
export | Export repository- or working copy-path into directory. Target path and source revision will be asked for. |
exportto | Export repository- or working copy-path into directory. Source path and source revision will be asked for. |
delete (del, remove, rm) | delete url(s) from repository or working copy. |
add | add url to working copy. url must belong to a working copy (its not an import!) |
revert (or undo) | undone current changes to working copy. May only used on working copy urls! |
checknew (or addnew) | check in given url for new, unversioned items and add them to working copy if wanted. |
tree | displays revision tree of item (only first argument), if url with "?rev=xxx" given, this revision is the peg-revision. | -r startrev:endrev
lock | lock url(s), if "-f" is given then existing locks are brocken. | -f
unlock | unlock url(s), if "-f" is given then not owned locks are brocken or non existing locks are ignored. | -f
help | displays this page |

#### Parameter for subversion commands

Parameter | Possible values | allowed for
--- | --- | ---
-r | revision or startrev:endrev | all except commit
-R | (none) | all except commit
-o | <filename> | get
-l | <number> | log
-f |  | (un-)lock

#### The "log" command

Log command displays a dialog containing the log of the given url. With subversion 1.2 or above it accepts a limit e.g. how many entries it has to display.

Inside that dialog you may select log entries and get the differences between them.

##### Display the last 20 commit logs

    kdesvn exec log -l 20 -r HEAD:1 myfile.c

Beware of order of revision: You want go from HEAD to START for the LAST one. So you must giverevision HEAD as starting point, otherwise you would get the first 20 entries.

#### The "diff" command

You get differences between revisions of an item or between to items inside same working copy or repository. When diff'ing revisions of an item that revisions may gived as -r STARTREV:ENDREV. When diffing an item inside a working copy without any revisions it prints the diff against repository.

##### Print difference against repository, eg. local changes

    kdesvn exec diff myfile.c

##### print difference between revisions

    kdesvn exec diff -r 21:20 myfile.c

When diffing two items revisions may be appended to url of items. e.g.:

    http://server/path/item?rev=HEAD

##### Diffing two tagged versions

    kdesvn exec diff http://www.alwins-world.de/repos/kdesvn/tags/rel_0_6_2 http://www.alwins-world.de/repos/kdesvn/tags/rel_0_6_3

## Settings

Setting may changed from the setup dialog. Them are seperated into some subdialogs.

### General

Size of listviewicons | How big (square) the icons in main list view should be
Show fileinfos | If a small tool-tip should appear when moving mouse over an item
Show preview in fileinfo | If kdesvn should show a preview in fileinfo tooltip (local access only, not on networked repositories)
Mark item status with iconoverlay | When an item isn't in normal subversion state it may get an overlay. (See )
Items sortorder is casesensitive | If the sortorder in mainwindow is case sensitivie or not, eg., if "a" not equal to "A".
External display | Default view on double-click. If set to default &kappname; uses standard action assigned with entry.
Maximum logmessages in history | How many logmessages &kappname; should remember.

### Subversion settings

Start check for updates when open a working copy | When open a working copy start a check for updates in background

Start fill log cache on open

If set &kappname; start (re-)filling the logcache when open a repository or working copy if repository url is not assigned local (

    file://

)

Check if items has svn:needs-lock set | Check on working copies if an item has this property set and if yes, displays a special overlayed icon. Setting this may let listings get real slow.
Get file details while remote listing | When checked, kdesvn get more detailed info about file items when making a listing to remote repositories. So you may see remote locks in overview. Be careful: This may let listings REAL slow!
Gain item info recursive | When activated, "info" on folders will gain information about all items below, may be real slow.
Display ignored files | Show items marked in subversion for ignore or not.
Store passwords for remote connections | Storing passwords is often a security problem. Subversion stores its passwords into a flat file, eg., passwords in cleartext! So be carefull setting this flag and see next entry, too. This item only says if saving passwords is the default, you may change it for specific realms inside login dialog.

Store passwords into KDE wallet

When saving passwords, the cleartext file from subversion is a security hole. &kappname; is able saving them into encrypted kde wallet instead there (starting with version 0.12.0) and use them. On other hand other subversion clients aren't able reading them so you must enter them if using tools like svn-cmdline or rapidsvn, too. As long as subversion don't encrypt password storage you should think twice about it.

Use internal password cache | When a password isn't stored persistent &kappname; may hold is until &kappname; ends so you may not need enter it again on each operation. This cache is never persistent, eg., it will not saved anywhere.
Log follows node changes | If checked log follows copy operations.
Logs always reads list of changed files | The logcommand may read list of changed files in commit. This is usefull and in most cases it cost not real more traffic.
Review items before commit | When doing a commit &kdesvn; may make a check what to do. Eg., if unversioned items are below which may added, list items changed and current operation will commit. This cost a depending on tree more or less time.
Maximum displayed logs when full log | Doing a "Full log" may cost a much, depending on start-revision. You may limit it to a default maximum value. If set to "0" it is unlimited.

### Diff & merge

Diff ignore contenttype

  Only interesting when diff are made with subversion itself. When set, than subversions diff ignores the content type of entries. Otherwise it will not output diffs from binaries.

Diff in revisiontree is recursive

  When set, diffs made from within revisiontree view are made recursive like in all other cases, too. Otherwise only changes belonging to that folderitems are shown. How that is made depends on how you let diffs generate (from subversion itself or from external viewers).

Diff ignores white space changes

  Ignore changes in the amount of white space (option "-b" to diff)

Diff ignores all white spaces

  Ignore all white space (option "-w" to diff)

#### Diff display

Selects which kind of display for diff-content should use. Default is "kompare" If set to "External display" you must enter a valid program in "External diff display". Only if internal display is used you may see differences in properties.

#### External diff display

Defines what &kdesvn; is using for external display and how it will called. There are three ways:

<program> <parameter>

  The difference will generated with subversion and put direct into standard input of the external program (eg., no temporary files needed)

<program> <parameter> %f

  The difference will generated with subversion, saved into a temporary file and the parameter "%f" will replaced with that filename. This may used with for instance with a simple call to less or textviewer.

<program> <parameter> %1 %2

  &kappname; let the external program make the difference. %1 and %2 will replaced with required values (filenames or foldernames). &kappname; stores content to compare in a temporary environment (when folders do a "export", when single file, does a "cat") when needed and cleans up after closing external program or closing itself.

Prefer external merge program

  Select if in merge dialog "Use external program" should be checked or not as default.

#### External merge program

Setup the program and options for using when subversions builtin merge isn't wanted. The default is kdiff3 %s1 %s2 %t. The order of substitution variables isn't important, and them may there more than once, eg. like kdiff3 -o %t %s1 %s2 %t. This stuff is only tested with "meld" and "kdiff3". Think about that external programs mostly doesn't know any about subversion ignore-parameter so them may show lot more than expected.

##### Variable substitutions for external merge program

%s1

  Substituted with source number one.

%s2

  Substituted with source number two. If this is empty or this is equal to source one and start and end revision is same, this variable will skipped. So be carefull setting up commandlines like xxdiff --title1 %s1 --title2 %s2 %s1 %s2 %t.

%t

  Substituted with target.

#### Conflict resolver program

You may use an external program like `kdiff3` for resolving conflicts, the default is kdiff3 %o %m %n -o %t.

##### Variable substitution for externel conflict resolver

In paranthesis after each description an example how subversion would call the files. This options meaning are designed for kdiff3, 'cause this moment (2008-02-07) this is the only one I know supporting all parameters required for a good conflict resolving.

%o or %l

  Old (local,left) version. This means the lower revsion number, eg., the start point of conflicted changes. (foo.cc.r2)

%m or %w

  Mine (working) version of file, eg., what you had changed against old version. (foo.cc.mine)

%n or %r

  New (remote, right) version of file. Eg, version someone other had made. (foo.cc.r3)

%t

  Target name, eg., the origin name. For kdiff3 (as an example) this would be name after the "-o" parameter (= output file). (foo.cc)

### KIO / commandline

Show log after executing a command

  Should a dialog open with the log of last made subversion command when it where done via commandline or konqueror action menu.

Minimum loglines to show

  If "Show log..." is set, what is the minimum of lines before such a dialog will shown. So you may set that such window will only shown when interesting output was generated (commitlog and so on)

Don't display contextmenu in konqueror

  If set, no action menu entry for kdesvn is made in konqueror. Works only with KDE 3.5.

KIO operations use standard logmessage.

  When making operations on a repository via the kdesvn KIO protocol from within konqueror (eg., "ksvn+..." protocols) on large operations like moving or copy folders kdesvn would ask for a logmessage for each item. This is a behavior of konqueror. When this option is set, the KIO implementation from kdesvn will not ask for a logmessage but set a standard logmessage. This flags not the operations from kdesvn action menu for konqueror but only copy/move/mkdir/delete made with konqueror or other filemanagers on a KIO-url.

Standard message

  The message kdesvn-kio should set on operations from within konqueror when the flag above is set. Default is "Revision made with kdesvn KIO."

## Command Reference

### The main &kdesvn; window

#### The File Menu

&Ctrl;O File Open

  Open a local working copy or a repository previously checked out

&Ctrl;W File Close

  Close current opened repository or working copy

&Ctrl;Q File Quit

  Quits &kdesvn;

#### The Bookmark Menu

see konqueror help

#### The Subversion Menu

&Ctrl;U Subversion Refresh view

  Refresh the current status of all displayed items. This will list each item asked for to be displayed at current status.

##### General subversion actions

&Ctrl;L Subversion General Full log

  Display lifetime log of the the currently selected item. Be careful, this list may be really big!

&Ctrl; &Shift;L Subversion General Log...

  Displays a log where a revision/date range may selected before.

I Subversion General Details

  Displays detailed information about selected item(s)

Subversion General Blame

  Makes an annotated list over all checkins. That may consume time!

Subversion General Blame range

  Annotate a range of commits for a file.

Subversion General Cat head

  Shows the content of the last commited version of that entry. (May be different to working copy version if working on a WC!)

F2 Subversion General Move

  Move or rename item inside working copy or in repository

F5 Subversion General Copy

  Copy item inside working copy or in repository

Del Subversion General Delete selected files/dirs

  Delete selected entries. If working in a working copy you must commit your deletions afterwards.

Subversion General Make (sub-)directory

  Create a new directory

Subversion General Import directories into current

  Select directories you want to import into the current selected directory

Subversion General Checkout a repository

  Creates a new working copy of a repository

Subversion General Export a repository

  Exports a repository to filesystem, eg. creates a clean directory tree without subversion information.

Subversion General Lock current items

  Mark current items as locked. Read the subversion handbook before using this!

Subversion General Unlock current items

  Remove locks on current items. Read the subversion handbook before using this!

##### Working copy

&Ctrl;u Subversion Working copy Update to head

  Update working copy to HEAD of repository

Subversion Working copy Update to revision...

  Update working copy to a specific revision of repository

# Subversion Working copy Commit

  Commit changes inside working copy for selected items to repository.

&Ctrl;D Subversion Working copy Diff local changes

  Display local changes as diff-output (without network access). This is the difference only to last state the working copy was updated to, not against the version in repository.

&Ctrl;H Subversion Working copy Diff against head

  Diff's current working copy against head of repository.

P Subversion Working copy Properties

  View/Edit properties assigned with current entry.

Insert Subversion Working copy Add selected files/dirs

  Add selected files and/or directories to version control.

Subversion Working copy Revert current changes

  Revert changes made in working copy and updates to last updated state.

Subversion Working copy Resolve recursive

  Mark conflicted items as not conflicted and removes associated files.

Subversion Working copy Merge two revisions

  Merge two revisions of entries into working copy.

Subversion Working copy Ignore/Unignore current item

  Edit property of parent directory of current item so that selected item will marked as ignored if not set, otherwise remove it from ignorelist.

Subversion Working copy Cleanup

  Clean up the working copy and removes (commit-)locks if any

Subversion Working copy Switch repository

  Switch the root of the current working copy. "relocate" This is not supported at this moment.

Subversion Working copy Switch to repository

  Opens the repository tree of another working copy.

##### Repository

Subversion Repository Checkout current repository path

  Create a working copy from the current selected entry if a directory.

Subversion Repository Export current repository path

  Create a clean copy on local filesystem from the current selected entry if a directory.

#### The Help Menu

&help.menu.documentation;

#### The subversion toolbar

Open

  Open a working copy

## Questions and Answers

When using the (k)svn+ssh protocol it asks all the time for password again. Why?

The "problem" is ssh itself. Subversion creates for each command sending a tunnel to the repository. And on each tunnel it is a new ssh connection. And for every connection ssh must authenticate. This may you fix when you store your local public identity to the host containing the repository. If your public identity has a password, ssh-agent will asked (when ssh-agent is installed).

When you're running a ssh-agent before starting &kdesvn;, you should add your identity to its cache, &kdesvn; will not modifiy it due security reasons, so it would ask for your password again and again. (see Manpage of ssh-add)

The password prompt for (k)svn+ssh comes on terminal when kdesvn started from there, how do I switch off this?

It may not switched off. This is a feature of ssh-agent itself, when it see it has a terminal it asks for password in terminal not in a X-Dialog like kdesvnaskpass. (see Manpage of ssh-add).

How can I give a different port or username to svn+ssh protocoll?

You may use an entry in $HOME/.ssh/config, see Ssh config manpage for exact syntax.

When checking for updates kdesvn doesn't display something but I know there are newer items!

Updates may only displayed when the remote server is subversion 1.2, too. Eg., seems that repository runs with subversion <1.2. It is not planned that &kdesvn; do that check recursive itself - this makes no sense. Ask for upgrading repository to newer subversion.

When starting kdesvn it sends a dialog "Could not find our part" and shows an empty window, why?

There are many reasons why the program couldn't load. This mostly happens when you building subversion-libs yourself. In that case you may check out issue entry.

The next big thing could that you forgot to give a libsuffix on 64-Bit systems at compile-time. So the part will installed in $PREFIX/lib instead of $PREFIX/lib64. So give -DLIB_SUFFIX=64 as paramter to cmake.

If this does not solve your problem, you may try out on a console:

      export LD_PRELOAD=/usr/lib/kde4/libkdesvnpart.so
      kdesvn
      unset LD_PRELOAD

(/usr/lib/kde4 depends of course on your system, please check where it is installed)

You should see a lot of output why loading of libkdesvnpart.so isn't possible, that may help solving your problem.

## Syntax for revisions

Revisions may given in same form like to the standard svn - client. That means: number, keyword or date.

Number

  A number greater or equal -1. -1 means "unspecified revision", 0 is the beginning. Normaly these numbers shouldn't used (most operations will fail with that).

Keyword

  One of

  - HEAD

  - BASE

  - COMMITED

  - PREV

  - START

  - WORKING

  The keywords are case sensitive! eg, head is not the same like HEAD.

Date

  Date in form {YYYY-MM-DD}. It must real MM or DD - eg. 2005-1-1 must written as {2005-01-01}.

Appending a specific revision to an url will always made via "?rev=<revision>.

## Further information

### Reporting bugs / Feedback

Bugreports and wishes may send to kdesvn-bugs@alwins-world.de, questions about usage or any other feedback to kdesvn@alwins-world.de.

An overview for the mailinglists for &kappname; you may get in the mailinglist overview.

### Credits and License and Thanks

Program copyright 2005-2006 Rajko Albrecht kdesvn@alwins-world.de

Many tnx to contributors:

- Andreas Richter ar@oszine.de - for qt4 port of svnqt

- Michael Biebl biebl@teco.edu - for a lot of help, ideas, implementation and hints.

- Bram Schoenmakers bramschoenmakers@kde.nl - for kde-specific hints, dutch translation, cleaning up my code.

And tnx to all other translators (I never thought that I get that fast such a lot of translations!) and for all of your positive and negative feedback. It helped a lot.

If you want your own translation for &kappname; and may want help please read on the homepage of &kappname; or ask on kdesvn-i10n@alwins-world.de mailinglist.

Documentation copyright 2005-2006 Rajko Albrecht kdesvn@alwins-world.de

&underFDL;

&underGPL;

## Installation

### How to obtain &kdesvn;

&kdesvn; itself can be found at the &kdesvn; download area.

You may get latest repository version when looking whats going on.

The homepage of that project is http://kdesvn.alwins-world.de/

### Requirements

You need installed subversion 1.3 or above and &kde; 4.1.x or above. Subversion prior 1.3 is NOT supported!

Subversion may found on its homepage but your distributor should have packages for your system and/or distribution.

You can find a list of changes at http://kdesvn.alwins-world.de/browser/trunk/ChangeLog.

### Compilation and Installation

&kappname; requires at least cmake 2.4 for building, automake isn't supported. The following steps works with both distribution tarball or tarball from repository. Unpack the archive or checkout / export a copy from repository and change to the resulting sourcedirectory.

    % mkdir build
    % cd build
    % cmake ../ -DCMAKE_INSTALL_PREFIX=`kde-config --prefix` -DCMAKE_BUILD_TYPE=Release
    % make
    % make install

&documentation.index;