Subversion Integration Functional Specification

This document describes planned functionality defined by requirements and use cases ("UC-#") and it forms a base for UI specification that should define the best UI for described tasks.

Target Audience

Experienced Subversion users, please read carefully and try to find out unsupported Subversion commands (or command arguments) that would block you from using implementation fullfilling this specification.

The document assumes basic experience with NetBeans 5.0 CVS support.

Note: The paper uses CVS terminology: branch, module, ... instead of the Subversion folder because it highlights folder function.

Note: The paper uses $-string notation for variables that depend on context. $-string name suggests what value is expected.

Summary of Requirements

• Quick Setup
• Update-Edit-Commit Workflow Integration
• Integration with IDE concepts Projects ("PI"), Filesystems ("FSI"), Refactoring ("RI") and Editor ("EI")

Tasks Concept

A task oriented approach is chosen as the primary wheel. Tasks that integrate with daily IDE user workflow, map to multiple versioning system commands, or suggest the best practices stands for the IDE added value. Furthermore usability criteria dictate that the IDE must primarily support daily and error prone (setup) tasks. The tasks selected here are based on use cases document.

Setup Tasks

Diff Tasks

Update-Edit-Commit Cycle Tasks

Source Archaeology Tasks

Project Branching Tasks

Subversion models CVS branches and tags using copies.

Put Project under Version Control Task

Subversion Commands

add

covered by commit task

blame (praise, annotate, ann)

covered by editor blame bar

cat

covered by history view

checkout (co)

covered by checkout wizard (except date range and nonrecursive option)

cleanup

unsupported, it looks like restore after unclean power-down command

commit (ci)

covered by commit task

copy (cp)

covered specialized tag and branch copying, TODO WC->WC, URL->URL

delete (del, remove, rm)

PATH delete covered by commit task, direct repository delete unsupported

diff (di)

covered by diff view TODO --notice-ancestry option

export

unsupported

import

covered by Import wizard

info

partially covered by editor blame bar

list (ls)

covered by repository browser

log

covered by history browser TODO --stop-on-copy option

merge

covered by Merge task TODO --dry-run

mkdir

covered by commit task

move (mv, rename, ren)

Note: this subcommand is equivalent to a 'copy' and 'delete'.

resolved

integrated with conflict resolver and commit task

revert

covered by Revert modification task

status (stat, st)

covered by Subversion view TODO properties

switch (sw)

covered by Switch action; --relocate special module such as CVSROOT chooser

update (up)

covered by Update and Merge actions

propdel (pdel, pd)

covered by properties editor and commit task TODO --revprop

propedit (pedit, pe)

unsupported

propget (pget, pg)

covered by properties editor

proplist (plist, pl)

covered by properties editor

propset (pset, ps)

covered by properties editor and commit task

svn:ignore

A newline separated list of file patterns to ignore.

svn:keywords

Keywords to be expanded.

svn:executable

If present, make the file executable.

svn:eol-style

One of 'native', 'LF', 'CR', 'CRLF'.

svn:mime-type

The mimetype of the file. A mimetype beginning with 'text/' (or an absent mimetype) is treated as text. Anything else is treated as binary.

svn:externals

A newline separated list of module specifiers.

svn:date

unsupported; --revprop commit date

svn:author

unsupported; --revprop commit author

svn:log

unsupported; --revprop commit message

There are available common options:

--force

force operation to run

--auto-props

enable automatic properties

--no-auto-props

disable automatic properties

All of them are unsupported by IDE task actions.

See Also

Teepee project - NetBeans Subversion integration
Jihlava project - NetBeans CVS Integration

---

Petr Kuzel on January 9th 2006
TODO to be discussed ...