/plugins/SVNPlugin/trunk/src/docs/index.html
# · HTML · 1168 lines · 1046 code · 122 blank · 0 comment · 0 complexity · 4583facc05a7293109834f8c638767fd MD5 · raw file
- <html>
- <head>
- <title>SVN Plugin</title>
- </head>
- <body>
- <h1>Subversion Plugin</h1>
- <p>
- Author: Dale Anson
- </p>
- <p>
- <a href="#intro">Intro</a><br>
- <a href="#installation">Installation</a><br>
- <a href="#0">Dockables</a><br>
- <a href="#1">Checking out a project</a><br>
- <a href="#1a">Option Settings</a><br>
- <a href="#2">Creating a project from existing files</a><br>
- <a href="#3">Handling individual files</a><br>
- <a href="#4">How to undelete a deleted file</a><br>
- <a href="#41">Merging</a><br>
- <a href="#5">Bugtraq</a><br>
- <a href="#50">Licenses</a><br>
- </p>
- <hr>
- <p>
- <a name="intro"><h2>Intro</h2></a>
- </p>
- <p>
- Subversion is a powerful, open source version control system designed as a replacement for the popular Concurrent Versions System (CVS). It offers many enhancements to CVS, such as versioned directories and atomic commits, and is architected for simpler, more flexible network access.
- </p>
- <p>
- The SVNPlugin is a plugin for using Subversion from within jEdit. This is an all Java implementation, using the SVNKit library internally, so no external libraries or subversion clients are required. This guide assumes you have some experience with Subversion.
- </p>
- <p>
- <b><i>
- As of version 1.2.3, this plugin supports backwards compatibility with older svn clients. This means your working copy file formats will NOT be automatically upgraded to the latest version, as was the case in the past. You can change the working copy version on a per project basis by using the project properties in ProjectViewer.
- </i></b>
- </p>
- <p>
- For Subversion command reference and general Subversion information, see the official Subversion reference manual:
- <a href="http://svnbook.red-bean.com/index.en.html" title="English"
- hreflang="en" lang="en" rel="alternate">Subversion Book</a> <br>
- </p>
- <p>
- This plugin is tightly integrated with ProjectViewer, and most commands are available by right clicking on files or folders in the ProjectViewer trees. Some commands for the current file are also available in the jEdit text area context menu. The SVN Browser has commands to work directly with repository files without needing to have a local copy of the files.
- </p>
- <hr>
- <p>
- <a name="installation"><h2>Installation</h2></a>
- </p>
- <p>
- Install SVNPlugin from within jEdit like any other plugin:
- <ol>
- <li>Click Plugins -> Plugin Manager</li>
- <li>Select the "Install" tab.</li>
- <li>Check "SVNPlugin"</li>
- <li>Click the "Install" button</li>
- </ol>
- </p>
- <p>
- SVNPlugin depends on the Project Viewer, Common Controls, and JDiff plugins. If you don't have these plugins installed, Plugin Manager will install them for you.
- </p>
- <hr>
- <p>
- <a name="0"><h2>Dockables</h2></a>
- </p>
- <p>
- The Subversion plugin provides 2 dockables to jEdit:<br>
- <ol>
- <li><a href="#svn_browser">SVN Browser</a></li>
- <li><a href="#svn_console">SVN Console</a></li>
- </ol>
- </p>
- <p>
- Access the dockables via the Plugins menu, Plugins -> SVN Plugin -> SVN Browser or SVN Console.
- </p>
- <p>
- You can dock them for easier access using Utilities -> Global Options... -> Docking.
- </p>
- <p>
- <a name="svn_browser"><h3>SVN Browser</h3></a>
- </p>
- <p>
- The SVN Browser is best docked at either the left or right:<br>
- <br>
- <img src="svn_browser.jpg">
- </p>
- <p>
- <h4>SVN Browser Buttons</h4>
- </p>
- <p>
- <table border="0">
- <tr>
- <td>
- <img src="add_repos.jpg">
- </td>
- <td>This button allows you to add a new repository to the SVN Browser.<td>
- </tr>
- </table>
- <br>
- Clicking this button brings up this dialog:<br>
- <br>
- <img src="add_repos_dialog.jpg"><br>
- <br>
- <ul>
- <li>Name: This is for a user-friendly name for the repository, like "jEdit Plugins".
- This can be whatever name you want for this repository.</li>
- <li>URL: This is the URL for the repository.</li>
- <li>Username: This is a username to access the repository. If the repository allows
- anonymous access, you can leave this blank.</li>
- <li>Password: The password that goes with Username.</li>
- </ul>
- </p>
- <p>
- <table border="0">
- <tr>
- <td>
- <img src="edit_repos.jpg">
- </td>
- <td>This button allows you to edit the settings for a repository.<td>
- </tr>
- </table>
- <br>
- Clicking this button brings up this dialog:<br>
- <br>
- <img src="edit_repos_dialog.jpg"><br>
- <br>
- These fields are identical to those in the Add Repository dialog shown above.
- </p>
- <p>
- <table border="0">
- <tr>
- <td>
- <img src="remove_repos.jpg">
- </td>
- <td>This button allows you to remove a repository from the SVN Browser. This
- does <strong>NOT</strong> delete anything from the repository or your local
- file system. It only removes the repository from the SVN Browser drop down
- list.<td>
- </tr>
- </table>
- <br>
- Clicking this button brings up this dialog:<br>
- <br>
- <img src="remove_repos_dialog.jpg"><br>
- <br>
- You must confirm to actually remove the repository from the SVN Browser.
- </p>
- <p>
- <table border="0">
- <tr>
- <td>
- <img src="refresh_repos.jpg">
- </td>
- <td>This button refreshes the SVN Browser from the currently selected repository.
- The SVN Browser tree is lazy-loaded since it can take some time to retrieve the
- repository data necessary to construct the tree. Folder contents are fetched only
- when the folder is expanded to show its contents. The refresh button will bring in
- any new data that may have been added since the last time the tree was loaded. Note that this button only refreshes the currently selected item in the tree, which is handy for situations where you have a large tree and only need to refresh a small part of it. If no node is selected in the tree, then the entire tree will be refreshed.<td>
- </tr>
- </table>
- <br>
- <br>
- <p>
- Right clicking on an item in the tree will show this popup menu:<br>
- <br>
- <img src="browser_context_menu.jpg">
- <br>
- The commands available on this menu are standard Subversion commands and shouldn't
- need additional explanation, although the "Checkout..." command is covered in some
- detail below.
- </p>
- <br>
- </p>
- <a name="svn_console">
- <h3>SVN Console</h3>
- </a>
- <p>
- The SVN Console has two main functions, first, it shows the raw output of the
- subversion command, and second, it shows the output of a command in a nice,
- GUI way.
- </p>
- <p>
- This dockable is best docked at the bottom of jEdit.
- </p>
- <p>
- Here is a shot of the SVN Console after running an "Info" command:<br>
- <br>
- <img src="svn_console_1.jpg"><br>
- <br>
- The "SVN Console" tab cannot be closed.
- </p>
- <p>
- And here is a shot of the Info command results:<br>
- <br>
- <img src="svn_console.jpg"><br>
- <br>
- The "Info" tab can be closed by clicking on the "X". It can also be closed
- by right clicking on it and choosing "Close". If there are multiple tabs open,
- they can all be closed by right clicking on any tab and choosing "Close All".
- Again, the "SVN Console" tab cannot be closed.
- </p>
- <p>
- Most commands show their output in a table or tree format. The table outputs
- are generally "editable", that is, they can be clicked on and the text can
- be selected for copying and pasting elsewhere. Many output displays also
- provide additional commands that can be accessed by right clicking on the
- output. For example, the "Status" command provides the ability to commit,
- add, revert, and so on. Most table outputs at least provide a "Zoom" option,
- this command will show the contents of a table cell in a popup window so that
- the full text can be viewed at once, and this text is selectable from the
- popup.
- </p>
- <hr>
- <p>
- <a name="1"><h2>Checking out a project</h2></a>
- </p>
- <p>
- If you are wanting to check out some files from a Subversion repository for the
- first time, do this:
- <br>
- <ol>
- <li>
- Right click on a directory or file in the SVN Browser, and choose "Checkout...".
- </li>
- <li>
- Fill in this dialog:<br>
- <br>
- <img src="checkout_dialog.jpg"><br>
- <br>
- <ul>
- <li>URL: should be filled in for you.</li>
- <li>Path: enter the location on your computer to put the files.</li>
- <li>Username and Password: username and password to access the repository. You can leave this blank if
- the repository allows anonymous access.</li>
- </ul>
- </li>
- <li>
- Wait for the files to be checked out.
- </li>
- <li>
- Choose "Yes" to create a project in Project Viewer:<br>
- <br>
- <img src="create_project_dialog.jpg"><br>
- <br>
- </li>
- <li>
- Fill in the information necessary to create the project:<br>
- </br>
- <img src="create_project_dialog_2.jpg"><br>
- <br>
- </li>
- <li>
- Last, actually import your files into your project. Be sure to choose the "Use CVS or SVN entries file" or
- all the .svn files will end up in your Project, which you probably don't want:<br>
- <br>
- <img src="initial_import.jpg"><br>
- <br>
- Project Viewer will automatically switch to your new project so you can begin working immediately.
- </li>
- </ol>
- <br>
- The ProjectViewer trees show the SVN status of files using these icons:
- <br>
- <br> <img src="added.png"> The file has been scheduled for "add" to the repository.<br>
- <br> <img src="conflict.png"> The file has a conflict that needs to be resolved.<br>
- <br> <img src="deleted.png"> The file has been deleted from the repository.<br>
- <br> <img src="ignored.png"> The file is ignored by Subversion.<br>
- <br> <img src="locked.png"> The file is locked by Subversion.<br>
- <br> <img src="modified.png"> The file has local modifications.<br>
- <br> <img src="normal.png"> The file is up to date.<br>
- <br> <img src="outofdate.png"> The file is out of date.<br>
- <br> <img src="readonly.png"> The file is read only.<br>
- <br> <img src="unversioned.png"> The file is not under version control.<br>
- <br>
- </p>
- <hr>
- <a name="1a">
- <h2>Option Settings</h2>
- </a>
- <p>
- Option settings are accessed from Plugins - Plugin Options - Subversion. Currently, there is only one setting for this plugin, whether or not to use a "tsvn:logtemplate" property as a template for commit messages. This is a property defined by the Tortoise SVN project and supported by many Subversion clients. It allows a template for commit comments to be set, usually on a project basis. Usually, this property is in set in Subversion on the top level folder and applies to all files contained within the folder. If checked, it may take slightly longer for a commit dialog to appear, as the SVN Plugin will need to query the Subversion server for the value of this property. Once the commit dialog does appear, the commit template will be displayed, which helps programmers remember to fill in particular pieces of information, such as bug number, reviewed by, and so on.
- </p>
- <hr>
- <a name="2">
- <h2>Creating a Project From Existing Files</h2>
- </a>
- <p>
- Suppose you have a directory of files already checked out from a Subversion
- repository. You can create a project from these files like this:
- </p>
- <p>
- <ol>
- <li>Activate the Project Viewer plugin.</li>
- <li>From the drop down at the top of Project Viewer, browse to the place you
- want to create the project and select "New project here".</li>
- <li>Fill in the dialog:<br>
- <br>
- <img src="create_new_project_dialog.jpg"><br>
- <br>
- Be sure to select "Subversion" from the Version Control drop down.
- <br>
- </li>
- <li>
- Next, you'll be asked to import your files into your project. Be sure to choose the "SVN Entries" filter or
- all the .svn files will end up in your Project, which you probably don't want:<br>
- <br>
- <img src="initial_import.jpg"><br>
- <br>
- Project Viewer will automatically switch to your new project so you can begin working immediately.<br>
- <br>
- </li>
- <li>
- Right click on the top node of your project and select "Properties". Select "Subversion" from the version control dropdown if it is not selected already. Select
- "Subversion settings" from the left panel. The URL should be filled in for you.
- If the repository requires a username and password, fill them in here, or leave the fields blank if the repository allows anonymous access. The format of your working copies is also displayed. You can change this value if you need to for compatibility with other SVN clients.<br>
- <br>
- <img src="subversion_settings.jpg"><br>
- <br>
- </li>
- <li>
- Click "OK" to save your settings.
- </li>
- </ol>
- </p>
- <hr>
- <p>
- <a name="3"><h2>Handling individual files</h2></a>
- </p>
- <p>
- There may be times when you are working on a file that is not in a Project Viewer
- project, but the file is under version control. All you want to do is update or
- commit that file. Several Subversion commands are available on the text area
- context menu. Right click anywhere in the text area and select the "Subversion"
- submenu:<br>
- <br>
- <img src="text_area_context_menu.jpg"><br>
- <br>
- </p>
- <p>
- Since the file may not be part of a Project Viewer project, each of the commands
- available on the context menu provide a place to enter the username and password
- for the Subversion repository. If the file does happen to be part of a Project
- Viewer project, the username and password will be found in the project settings
- and the username and password boxes will be pre-filled for you.
- </p>
- <p>
- Note that if the file is not in fact under version control, you will receive
- and error from each of these commands.
- </p>
- <hr>
- <p>
- <a name="4"><h2>How to undelete a deleted file</h2></a>
- </p>
- <p>
- <ol>
- <li>First, run the log command on the directory containing the deleted file or directory. Be sure "Show paths" is checked.</li>
- <li>Find the deleted file in the log output.</li>
- <li>Right click on the deleted file and select "Undelete" from the popup menu.</li>
- <li>Use the dialog to confirm the file is to be undeleted.</li>
- <li>Your file should be restored to its original location.</li>
- <li>At this point, the file is scheduled for add, so you'll still need to commit.</li>
- <li>That's it!</li>
- </ol>
- Don't forget that in subversion, a "move" is really a "copy" followed by a "delete". To undo a "move", your best bet
- is to just "move" the files back. Doing a "revert" does NOT undo a "move". If you do "revert", your moved files will
- be removed from their new destination, and then you'll also need to follow the undelete instructions above to get them
- back into their original location.<br>
- <br>
- </p>
- <hr>
- <p>
- <a name="41"><h2>Merging</h2></a>
- </p>
- <p>
- Merging is not hard, it just takes practice. Hopefully, the GUI for doing merges with the SVN Plugin helps make it easier, but when in doubt, use the command line.
- </p>
- <p>
- The merge dialog lets you choose the source, revision(s) and destination for merging.
- </p>
- <p>
- <img src="merge_dialog.jpg">
- </p>
- <p>
- The merge dialog has these features:
- <ul>
- <li>Select source file or directory from either the local file system or the repository.</li>
- <li>Select a single revision or a revision range for the merge.</li>
- <li>The "to" range is synchronized with the "from" path and revision so it is easy to set up those "-c" style merges.</li>
- <li>Select destination directory from the local file system.</li>
- <li>"Dry run" and "Recursive" are selected by default since these are common choices.</li>
- <li>Show a preview of the equivalent svn command. This is great for verifying that the plugin is going to do the right thing.</li>
- </ul>
- </p>
- <p>
- Doing a "dry run" merge will show full merge output in the SVN Console. This will let you see all files that have conflicts, adds, deletes, merged, etc. This view is not interactive, since it is just a preview of what will happen in the merge.
- </p>
- <p>
- Doing an actual merge (dry run unchecked) will show the same output as a dry run merge, then will be followed by a Status on the working directory. This is the same status that is shown when doing a regular status, and has the same popup commands for resolving conflicts, diff, log, etc.
- </p>
- <p>
- <b>How to merge</b><br>
- This section is about how to merge using the SVN plugin. The tips provided here also apply to command-line svn. This is not an all-inclusive guide, nor does it cover all situations, but it does cover the most common use cases.
- </p>
- <br>
- <br>
- General tips:
- <ol>
- <li>Read the official Subversion documentation. It goes into great detail about merging and branching and is well worth reading.</li>
- <li>Always do merges locally. Check out the code branch to merge from and the code branch to merge to to your local machine.</li>
- <li>Make sure both branches for your merge are up to date.</li>
- <li>Before doing a switch, make sure your current branch is up to date and changes have been checked in. Files with uncommitted changes will not be switched, which can cause no end of problems.</li>
- <li>Always use explicit revision numbers for merging, avoid using HEAD. Doing merges locally (see #1) reduces the danger of using HEAD as a revision parameter. If you must merge from the repository, using HEAD is not necessarily safe since someone else could check in changes that you are not aware of and those changes can get lost.</li>
- <li>If you are working on a development branch that will eventually be merged back to trunk, do regular merges from trunk to your branch. Depending on the pace of your development team, you may need to merge daily, and probably not less than weekly. The more changes that are made, the more often you'll need to merge. It is much easier to a lot of small merges than one large merge.</li>
- <li>Keep a merge diary. You can keep it in a notebook, or a document checked into Subversion. Keep track of dates, revisions, and what branch was merged to where.</li>
- <li><b>Make good comments in your commits!</b> For example, "Merged from trunk at revision 1066", or "Merged from Widget branch from revision 102 to revision 151." This is especially critical when you are working on a development branch and need to regularly merge changes from trunk to your branch.</li>
- <li>You can find the revision that a branch was created at by running a log command on the branch. In the SVN Plugin, click on the branch in the SVN Browser, choose "Log" from the popup menu, check "Stop on copy", then show the log. In the Path column of the last log entry, you'll see something like <br><code>A /test3/branches/branch1 (from /test3/trunk revision 21)</code><br> The part in the parenthesis tells you exactly where the branch came from.</li>
- </ol>
- <br>
- <br>
- <b>Situation 1:</b> You fixed a bug in a single revision on a release branch and want to merge that change to trunk. This assumes you have the trunk already checked out locally. This diagram shows the situation:
- <br>
- <img src="merge_branch_to_trunk_1.jpg">
- <br>
- You want to merge the fix in revision 1034 to trunk. This revision may contain one or more files.
- <br>
- <br>
- Steps:
- <ol>
- <li>Open the merge dialog.</li>
- <li>In the "merge from" box, select the top level directory containing your branch code. The "To this path/revision" box will automatically fill in with the same path.</li>
- <li>In the top revision box, enter "1034" to specify the single revision you want to merge. The revision box in the "To this path/revision" will automatically fill with the same revision number.</li>
- <li>Select the directory containing the trunk code in the "working directory" box.</li>
- <li>Uncheck the "dry run" checkbox. (Or leave it checked and do a dry run first, which is always a good idea.)</li>
- <li>Click the "Show" button beside the command-line preview box. You should see:<br>
- <code>svn merge -c 1034 branch_directory trunk_directory</code></li>
- <li>Click the "Ok" button.</li>
- <li>Resolve any conflicts, build, run unit tests, etc, then commit.</li>
- </ol>
- <br>
- <br>
- <b>Situation 2:</b> You have been working on a development branch while others have been working on trunk. You want to merge the latest changes on trunk into your branch so you are working with the latest trunk code. This assumes you have both your working branch and trunk checked out locally. This diagram describes the situation:
- <br>
- <img src="trunk_to_dev_branch.jpg">
- <br>
- You previously merged from trunk to your dev branch at revision 2167 and currently head of trunk is revision 2182. You want to merge all changes on trunk from revision 2167 through 2182 to your development branch. This assumes you have both the trunk and your development branch checked out locally, and that both the trunk code and development branch code are up to date.
- <br>
- <br>
- Steps:
- <ol>
- <li>Open the merge dialog.</li>
- <li>In the "merge from" box, use the "Local" button to select the top level directory containing your trunk code. The "To this path/revision" box will automatically fill in with the same path.</li>
- <li>Enter "2167" in the top revision box.</li>
- <li>The revision box in the "To this path/revision" will automatically fill with the same revision number. Change it to "2182"</li>
- <li>Select the directory containing your development branch code in the "working directory" box.</li>
- <li>Uncheck the "dry run" checkbox. (Or leave it checked and do a dry run first, which is always a good idea.)</li>
- <li>Click the "Show" button beside the command-line preview box. You should see:<br>
- <code>svn merge -r 2167:2182 trunk_directory branch_directory</code></li>
- <li>Click the "Ok" button.</li>
- <li>Resolve any conflicts, build, run unit tests, etc, then commit from your development branch.</li>
- </ol>
- <br>
- <br>
- <b>Situation 3:</b> You have been working on a development branch while others have been working on trunk. You have completed work on the branch and are ready to merge your code to trunk. This assumes you have both your working branch and trunk checked out locally. This diagram describes the situation:
- <br>
- <img src="dev_branch_to_trunk.jpg">
- <br>
- The development branch was created from the trunk at revision 2149, and the current head of the branch is revision 2195. You want to merge your entire branch to trunk.
- <br>
- <br>
- Steps:
- <ol>
- <li>Open the merge dialog.</li>
- <li>In the "merge from" box, use the "Local" button to select the top level directory containing your development branch code. The "To this path/revision" box will automatically fill in with the same path.</li>
- <li>Enter "2149" in the top revision box.</li>
- <li>The revision box in the "To this path/revision" will automatically fill with the same revision number. Change it to "2195"</li>
- <li>Select the directory containing your trunk code in the "working directory" box.</li>
- <li>Uncheck the "dry run" checkbox. (Or leave it checked and do a dry run first, which is always a good idea.)</li>
- <li>Click the "Show" button beside the command-line preview box. You should see:<br>
- <code>svn merge -r 2149:2195 branch_directory trunk_directory</code></li>
- <li>Click the "Ok" button.</li>
- <li>Resolve any conflicts, build, run unit tests, etc, then commit your trunk code.</li>
- </ol>
- <b>Recovering from a bad merge:</b>
- <br>
- It happens. You pick the wrong directory, or merge the wrong way, or merge from the wrong revisions. Since you did everything locally and all your code was up to date from the repository, there is no harm done -- as long as you haven't committed yet. Just "Revert" your changes from your working directory. If you are not comfortable with that, you can also delete your "from" and "working" directories, check them both out from the repository, and do the merge again.
- <br>
- <br>
- If you have already committed your changes, you can do a "reverse merge":
- <ol>
- <li>Open the merge dialog.</li>
- <li>Select the top level of your working directory in the "merge from" box.</li>
- <li>Enter the revision that contained the bad merge, for example, 2196.</li>
- <li>In the "to path/revision", enter one revision less, continuing the example, enter 2195.</li>
- <li>Set the working directory to the same as the "merge from" box.</li>
- <li>Click the "Show" button beside the command-line preview box. You should see:<br>
- <code>svn merge -r 2196:2195 working_directory working_directory</code></li>
- <li>Click the "Ok" button.</li>
- <li>Resolve any conflicts, build, run unit tests, etc, then commit your trunk code.</li>
- </ol>
- <hr>
- <p>
- <a name="5"><h2>Bugtraq</h2></a>
- </p>
- <p>
- Bugtraq is a way to integrate Subversion with issue trackers. This plugin fully
- supports the Bugtraq standard.
- </p>
- <p>
- Bugtraq properties are set on folders, and the properties are applied to all files/directories
- under that folder. Typically, these properties are set on the "trunk" folder and folders within
- "branches". The SVNPlugin will check up the directory structure until the project root is
- reached and use any Bugtraq properties found. Note that if the Bugtraq properties are only
- set on "trunk" and users checkout a folder below that, they won't have access to the Bugtraq
- properties. You can apply the properties recursively in this case.
- </p>
- <p>
- <img src="bugtraq_properties.jpg">
- </p>
- <p>
- This image shows 6 of the 7 possible Bugtraq properties:
- <ul>
- <li>bugtraq:number -- if true, allows only numbers and commas to be entered into the bug entry field on the commit dialog.</li>
- <li>bugtraq:label -- this text is displayed in the commit dialog next to the bug entry field.</li>
- <li>bugtraq:warnifnoissue -- if true, this will cause the commit dialog to display a warning if the bug entry field is empty.</li>
- <li>bugtraq:message -- this text is added to the commit message with the bug id from the bug entry field included in the message.</li>
- <li>bugtraq:append -- if true, the bugtraq:message text is added at the end of the commit message, otherwise, it is inserted before the commit message.</li>
- <li>bugtraq:url -- this is used in the svn log display to link to a bug tracker. If there is a bug number in the log message, you can right click on the message
- and select "Open link in browser" to open a browser window with the contents of the appropriate issue tracker.</li>
- </ul>
- </p>
- <p>
- The property not shown above is "bugtraq:logregex".
- If two expressions are set, then the first expression is used to find a
- string which relates to a 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.
- An example:
- if you want to catch every pattern "issue #XXX" and "issue #890, #789" inside
- a log message you could use the following regex strings:<br>
- [Ii]ssue #?(\d+)(,? ?#?(\d+))+<br>
- (\d+)
- </p>
- <p>
- More details are available in the <a href="issuetrackers.html">Bugtraq specification</a>.<br>
- </p>
- <hr>
- <p>
- <a name="50"><h2>Licenses</h2></a>
- </p>
- <p>
- <b>SVN Plugin</b><br>
- <br>
- The SVNPlugin is licensed as follows:
- <pre>
- Copyright (c) 2007, Dale Anson
- All rights reserved.
- Redistribution and use in source and binary forms, with or without modification,
- are permitted provided that the following conditions are met:
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
- * Neither the name of the author nor the names of its contributors
- may be used to endorse or promote products derived from this software without
- specific prior written permission.
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- </pre>
- </p>
- <p>
- <b>SVNKit Library</b><br>
- <br>
- This plugin uses the SVNKit library (www.svnkit.com) from TMate Software, which has this license:
- <pre>
- The TMate License
- This license applies to all portions of TMate SVNKit library, which
- are not externally-maintained libraries (e.g. Ganymed SSH library).
- All the source code and compiled classes in package org.tigris.subversion.javahl
- except SvnClient class are covered by the license in JAVAHL-LICENSE file
- Copyright (c) 2004-2007 TMate Software. All rights reserved.
- Redistribution and use in source and binary forms, with or without modification,
- are permitted provided that the following conditions are met:
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
- * Redistributions in any form must be accompanied by information on how to
- obtain complete source code for the software that uses SVNKit and any
- accompanying software that uses the software that uses SVNKit. The source
- code must either be included in the distribution or be available for no
- more than the cost of distribution plus a nominal fee, and must be freely
- redistributable under reasonable conditions. For an executable file, complete
- source code means the source code for all modules it contains. It does not
- include source code for modules or files that typically accompany the major
- components of the operating system on which the executable file runs.
- * Redistribution in any form without redistributing source code for software
- that uses SVNKit is possible only when such redistribution is explictly permitted
- by TMate Software. Please, contact TMate Software at support@svnkit.com to
- get such permission.
- THIS SOFTWARE IS PROVIDED BY TMATE SOFTWARE ``AS IS'' AND ANY EXPRESS OR IMPLIED
- WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE
- DISCLAIMED.
- IN NO EVENT SHALL TMATE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
- INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
- OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- </pre>
- </p>
- <p>
- <b>Date Selector Utility</b><br>
- <br>
- This plugin uses the Date Selector Utility as published in the July 2003
- issue of JavaWorld:<br>
- <br>
- This program contains Allen Holub's Date Selector utility.
- (c) 2003 Allen I. Holub. All Rights Reserved.
- </p>
- <p>
- <b>SwingWorker</b><br>
- <br>
- This plugin also uses the original SwingWorker library, which is licensed as follows.
- Once Java 1.6 becomes more widespread, I'll replace this library with the SwingWorker
- classes distributed with Java itself.
- <pre>
- Copyright (c) 2005 Sun Microsystems, Inc., 4150 Network Circle, Santa
- Clara, California 95054, U.S.A. All rights reserved. Use is subject
- to license terms below. Sun, Sun Microsystems and the Sun logo are
- trademarks or registered trademarks of Sun Microsystems, Inc. in the
- U.S. and other countries.
- Notice: This product is covered by U.S. export control laws and may be
- subject to the export or import laws in other countries. These laws may
- restrict the fields of use for this software and may require you to
- secure government authorization.
- GNU LESSER GENERAL PUBLIC LICENSE
- Version 2.1, February 1999
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
- [This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
- Preamble
- The licenses for most software are designed to take away your
- freedom to share and change it. By contrast, the GNU General Public
- Licenses are intended to guarantee your freedom to share and change
- free software--to make sure the software is free for all its users.
- This license, the Lesser General Public License, applies to some
- specially designated software packages--typically libraries--of the
- Free Software Foundation and other authors who decide to use it. You
- can use it too, but we suggest you first think carefully about whether
- this license or the ordinary General Public License is the better
- strategy to use in any particular case, based on the explanations below.
- When we speak of free software, we are referring to freedom of use,
- not price. Our General Public Licenses are designed to make sure that
- you have the freedom to distribute copies of free software (and charge
- for this service if you wish); that you receive source code or can get
- it if you want it; that you can change the software and use pieces of
- it in new free programs; and that you are informed that you can do
- these things.
- To protect your rights, we need to make restrictions that forbid
- distributors to deny you these rights or to ask you to surrender these
- rights. These restrictions translate to certain responsibilities for
- you if you distribute copies of the library or if you modify it.
- For example, if you distribute copies of the library, whether gratis
- or for a fee, you must give the recipients all the rights that we gave
- you. You must make sure that they, too, receive or can get the source
- code. If you link other code with the library, you must provide
- complete object files to the recipients, so that they can relink them
- with the library after making changes to the library and recompiling
- it. And you must show them these terms so they know their rights.
- We protect your rights with a two-step method: (1) we copyright the
- library, and (2) we offer you this license, which gives you legal
- permission to copy, distribute and/or modify the library.
- To protect each distributor, we want to make it very clear that
- there is no warranty for the free library. Also, if the library is
- modified by someone else and passed on, the recipients should know
- that what they have is not the original version, so that the original
- author's reputation will not be affected by problems that might be
- introduced by others.
- Finally, software patents pose a constant threat to the existence of
- any free program. We wish to make sure that a company cannot
- effectively restrict the users of a free program by obtaining a
- restrictive license from a patent holder. Therefore, we insist that
- any patent license obtained for a version of the library must be
- consistent with the full freedom of use specified in this license.
- Most GNU software, including some libraries, is covered by the
- ordinary GNU General Public License. This license, the GNU Lesser
- General Public License, applies to certain designated libraries, and
- is quite different from the ordinary General Public License. We use
- this license for certain libraries in order to permit linking those
- libraries into non-free programs.
- When a program is linked with a library, whether statically or using
- a shared library, the combination of the two is legally speaking a
- combined work, a derivative of the original library. The ordinary
- General Public License therefore permits such linking only if the
- entire combination fits its criteria of freedom. The Lesser General
- Public License permits more lax criteria for linking other code with
- the library.
- We call this license the "Lesser" General Public License because it
- does Less to protect the user's freedom than the ordinary General
- Public License. It also provides other free software developers Less
- of an advantage over competing non-free programs. These disadvantages
- are the reason we use the ordinary General Public License for many
- libraries. However, the Lesser license provides advantages in certain
- special circumstances.
- For example, on rare occasions, there may be a special need to
- encourage the widest possible use of a certain library, so that it becomes
- a de-facto standard. To achieve this, non-free programs must be
- allowed to use the library. A more frequent case is that a free
- library does the same job as widely used non-free libraries. In this
- case, there is little to gain by limiting the free library to free
- software only, so we use the Lesser General Public License.
- In other cases, permission to use a particular library in non-free
- programs enables a greater number of people to use a large body of
- free software. For example, permission to use the GNU C Library in
- non-free programs enables many more people to use the whole GNU
- operating system, as well as its variant, the GNU/Linux operating
- system.
- Although the Lesser General Public License is Less protective of the
- users' freedom, it does ensure that the user of a program that is
- linked with the Library has the freedom and the wherewithal to run
- that program using a modified version of the Library.
- The precise terms and conditions for copying, distribution and
- modification follow. Pay close attention to the difference between a
- "work based on the library" and a "work that uses the library". The
- former contains code derived from the library, whereas the latter must
- be combined with the library in order to run.
- GNU LESSER GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
- 0. This License Agreement applies to any software library or other
- program which contains a notice placed by the copyright holder or
- other authorized party saying it may be distributed under the terms of
- this Lesser General Public License (also called "this License").
- Each licensee is addressed as "you".
- A "library" means a collection of software functions and/or data
- prepared so as to be conveniently linked with application programs
- (which use some of those functions and data) to form executables.
- The "Library", below, refers to any such software library or work
- which has been distributed under these terms. A "work based on the
- Library" means either the Library or any derivative work under
- copyright law: that is to say, a work containing the Library or a
- portion of it, either verbatim or with modifications and/or translated
- straightforwardly into another language. (Hereinafter, translation is
- included without limitation in the term "modification".)
- "Source code" for a work means the preferred form of the work for
- making modifications to it. For a library, complete source code means
- all the source code for all modules it contains, plus any associated
- interface definition files, plus the scripts used to control compilation
- and installation of the library.
- Activities other than copying, distribution and modification are not
- covered by this License; they are outside its scope. The act of
- running a program using the Library is not restricted, and output from
- such a program is covered only if its contents constitute a work based
- on the Library (independent of the use of the Library in a tool for
- writing it). Whether that is true depends on what the Library does
- and what the program that uses the Library does.
- 1. You may copy and distribute verbatim copies of the Library's
- complete source code as you receive it, in any medium, provided that
- you conspicuously and appropriately publish on each copy an
- appropriate copyright notice and disclaimer of warranty; keep intact
- all the notices that refer to this License and to the absence of any
- warranty; and distribute a copy of this License along with the
- Library.
- You may charge a fee for the physical act of transferring a copy,
- and you may at your option offer warranty protection in exchange for a
- fee.
- 2. You may modify your copy or copies of the Library or any portion
- of it, thus forming a work based on the Library, and copy and
- distribute such modifications or work under the terms of Section 1
- above, provided that you also meet all of these conditions:
- a) The modified work must itself be a software library.
- b) You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
- c) You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
- d) If a facility in the modified Library refers to a function or a
- table of data to be supplied by an application program that uses
- the facility, other than as an argument passed when the facility
- is invoked, then you must make a good faith effort to ensure that,
- in the event an application does not supply such function or
- table, the facility still operates, and performs whatever part of
- its purpose remains meaningful.
- (For example, a function in a library to compute square roots has
- a purpose that is entirely well-defined independent of the
- application. Therefore, Subsection 2d requires that any
- application-supplied function or table used by this function must
- be optional: if the application does not supply it, the square
- root function must still compute square roots.)
- These requirements apply to the modified work as a whole. If
- identifiable sections of that work are not derived from the Library,
- and can be reasonably considered independent and separate works in
- themselves, then this License, and its terms, do not apply to those
- sections when you distribute them as separate works. But when you
- distribute the same sections as part of a whole which is a work based
- on the Library, the distribution of the whole must be on the terms of
- this License, whose permissions for other licensees extend to the
- entire whole, and thus to each and every part regardless of who wrote
- it.
- Thus, it is not the intent of this section to claim rights or contest
- your rights to work written entirely by you; rather, the intent is to
- exercise the right to control the distribution of derivative or
- collective works based on the Library.
- In addition, mere aggregation of another work not based on the Library
- with the Library (or with a work based on the Library) on a volume of
- a storage or distribution medium does not bring the other work under
- the scope of this License.
- 3. You may opt to apply the terms of the ordinary GNU General Public
- License instead of this License to a given copy of the Library. To do
- this, you must alter all the notices that refer to this License, so
- that they refer to the ordinary GNU General Public License, version 2,
- instead of to this License. (If a newer version than version 2 of the
- ordinary GNU General Public License has appeared, then you can specify
- that version instead if you wish.) Do not make any other change in
- these notices.
- Once this change is made in a given copy, it is irreversible for
- that copy, so the ordinary GNU General Public License applies to all
- subsequent copies and derivative works made from that copy.
- This option is useful when you wish to copy part of the code of
- the Library into a program that is not a library.
- 4. You may copy and distribute the Library (or a portion or
- derivative of it, under Section 2) in object code or executable form
- under the terms of Sections 1 and 2 above provided that you accompany
- it with the complete corresponding machine-readable source code, which
- must be distributed under the terms of Sections 1 and 2 above on a
- medium customarily used for software interchange.
- If distribution of object code is made by offering access to copy
- from a designated place, then offering equivalent access to copy the
- source code from the same place satisfies the requirement to
- distribute the source code, even though third parties are not
- compelled to copy the source along with the object code.
- 5. A program that contains no derivative of any portion of the
- Library, but is designed to work with the Library by being compiled or
- linked with it, is called a "work that uses the Library". Such a
- work, in isolation, is not a derivative work of the Library, and
- therefore falls outside the scope of this License.
- However, linking a "work that uses the Library" with the Library
- creates an executable that is a derivative of the Library (because it
- contains portions of the Library), rather than a "work that uses the
- library". The executable is therefore covered by this License.
- Section 6 states terms for distribution of such executables.
- When a "work that uses the Library" uses material from a header file
- that is part of the Library, the object code for the work may be a
- derivative work of the Library even though the source code is not.
- Whether this is true is especially significant if the work can be
- linked without the Library, or if the work is itself a library. The
- threshold for this to be true is not precisely defined by law.
- If such an object file uses only numerical parameters, data
- structure layouts and accessors, and small macros and small inline
- functions (ten lines or less in length), then the use of the object
- file is unrestricted, regardless of whether it is legally a derivative
- work. (Executables containing this object code plus portions of the
- Library will still fall under Section 6.)
- Otherwise, if the work is a derivative of the Library, you may
- distribute the object code for the work under the terms of Section 6.
- Any executables containing that work also fall under Section 6,
- whether or not they are linked directly with the Library itself.
- 6. As an exception to the Sections above, you may also combine or
- link a "work that uses the Library" with the Library to produce a
- work containing portions of the Library, and distribute that work
- under terms of your choice, provided that the terms permit
- modification of the work for the customer's own use and reverse
- engineering for debugging such modifications.
- You must give prominent notice with each copy of the work that the
- Library is used in it and that the Library and its use are covered by
- this License. You must supply a copy of this License. If the work
- during execution displays copyright notices, you must include the
- copyright notice for the Library among them, as well as a reference
- directing the user to the copy of this License. Also, you must do one
- of these things:
- a) Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever
- changes were used in the work (which must be distributed under
- Sections 1 and 2 above); and, if the work is an executable linked
- with the Library, with the complete machine-readable "work that
- uses the Library", as object code and/or source code, so that the
- user can modify the Library and then relink to produce a modified
- executable containing the modified Library. (It is understood
- that the user who changes the contents of definitions files in the
- Library will not necessarily be able to recompile the application
- to use the modified definitions.)
- b) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a
- copy of the library already present on the user's computer system,
- rather than copying library functions into the executable, and (2)
- will operate properly with a modified version of the library, if
- the user installs one, as long as the modified version is
- interface-compatible with the version that the work was made with.
- c) Accompany the work with a written offer, valid for at
- least three years, to give the same user the materials
- specified in Subsection 6a, above, for a charge no more
- than the cost of performing this distribution.
- d) If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above
- specified materials from the same place.
- e) Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
- For an executable, the required form of the "work that uses the
- Library" must include any data and utility programs needed for
- reproducing the executable from it. However, as a special exception,
- the materials to be distributed need not include anything that is
- normally distributed (in either source or binary form) with the major
- components (compiler, kernel, and so on) of the operating system on
- which the executable runs, unless that component itself accompanies
- the executable.
- It may happen that this requirement contradicts the license
- restrictions of other proprietary libraries that do not normally
- accompany the operating system. Such a contradiction means you cannot
- use both them and the Library together in an executable that you
- distribute.
- 7. You may place library facilities that are a work based on the
- Library side-by-side in a single library together with other library
- facilities not covered by this License, and distribute such a combined
- library, provided that the separate distribution of the work based on
- the Library and of the other library facilities is otherwise
- permitted, and provided that you do these two things:
- a) Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library
- facilities. This must be distributed under the terms of the
- Sections above.
- b) Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining
- where to find the accompanying uncombined form of the same work.
- 8. You may not copy, modify, sublicense, link with, or distribute
- the Library except as expressly provided under this License. Any
- attempt otherwise to copy, modify, sublicense, link with, or
- distribute the Library is void, and will automatically terminate your
- rights under this License. However, parties who have received copies,
- or rights, from you under this License will not have their licenses
- terminated so long as such parties remain in full compliance.
- 9. You are not required to accept this License, since you have not
- signed it. However, nothing else grants you permission to modify or
- distribute the Library or its derivative works. These actions are
- prohibited by law if you do not accept this License. Therefore, by
- modifying or distributing the Library (or any work based on the
- Library), you indicate your acceptance of this License to do so, and
- all its terms and conditions for copying, distributing or modifying
- the Library or works based on it.
- 10. Each time you redistribute the Library (or any work based on the
- Library), the recipient automatically receives a license from the
- original licensor to copy, distribute, link with or modify the Library
- subject to these terms and conditions. You may not impose any further
- restrictions on the recipients' exercise of the rights granted herein.
- You are not responsible for enforcing compliance by third parties with
- this License.
- 11. If, as a consequence of a court judgment or allegation of patent
- infringement or for any other reason (not limited to patent issues),
- conditions are imposed on you (whether by court order, agreement or
- otherwise) that contradict the conditions of this License, they do not
- excuse you from the conditions of this License. If you cannot
- distribute so as to satisfy simultaneously your obligations under this
- License and any other pertinent obligations, then as a consequence you
- may not distribute the Library at all. For example, if a patent
- license would not permit royalty-free redistribution of the Library by
- all those who receive copies directly or indirectly through you, then
- the only way you could satisfy both it and this License would be to
- refrain entirely from distribution of the Library.
- If any portion of this section is held invalid or unenforceable under any
- particular circumstance, the balance of the section is intended to apply,
- and the section as a whole is intended to apply in other circumstances.
- It is not the purpose of this section to induce you to infringe any
- patents or other property right claims or to contest validity of any
- such claims; this section has the sole purpose of protecting the
- integrity of the free software distribution system which is
- implemented by public license practices. Many people have made
- generous contributions to the wide range of software distributed
- through that system in reliance on consistent application of that
- system; it is up to the author/donor to decide if he or she is willing
- to distribute software through any other system and a licensee cannot
- impose that choice.
- This section is intended to make thoroughly clear what is believed to
- be a consequence of the rest of this License.
- 12. If the distribution and/or use of the Library is restricted in
- certain countries either by patents or by copyrighted interfaces, the
- original copyright holder who places the Library under this License may add
- an explicit geographical distribution limitation excluding those countries,
- so that distribution is permitted only in or among countries not thus
- excluded. In such case, this License incorporates the limitation as if
- written in the body of this License.
- 13. The Free Software Foundation may publish revised and/or new
- versions of the Lesser General Public License from time to time.
- Such new versions will be similar in spirit to the present version,
- but may differ in detail to address new problems or concerns.
- Each version is given a distinguishing version number. If the Library
- specifies a version number of this License which applies to it and
- "any later version", you have the option of following the terms and
- conditions either of that version or of any later version published by
- the Free Software Foundation. If the Library does not specify a
- license version number, you may choose any version ever published by
- the Free Software Foundation.
- 14. If you wish to incorporate parts of the Library into other free
- programs whose distribution conditions are incompatible with these,
- write to the author to ask for permission. For software which is
- copyrighted by the Free Software Foundation, write to the Free
- Software Foundation; we sometimes make exceptions for this. Our
- decision will be guided by the two goals of preserving the free status
- of all derivatives of our free software and of promoting the sharing
- and reuse of software generally.
- NO WARRANTY
- 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
- WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
- EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
- OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
- KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
- LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
- THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
- 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
- WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
- AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
- FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
- CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
- LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
- RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
- FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
- SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
- DAMAGES.
- END OF TERMS AND CONDITIONS
- </pre>
- </p>
- </body>
- </html>