[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [PATCH] - Help text for Subclipse

From: Jesper Steen M°ller <jesper_at_selskabet.org>
Date: 2004-11-17 14:34:07 CET

CÚdric Chabanois wrote:

> Hi !
> Thanks for this patch.
> However could you please attach the patch to the mail instead of
> pasting it in the content of the mail ?

Sure, I just thought it was "how it was done".

Here is the patch in one file, made relative to the 'ui' folder. There's
more to come once I'm clear of my flu and the functional changes are
committed so they can be described.

Comments are appreciated.

-Jesper

Index: toc.xml
===================================================================
--- toc.xml (revision 1065)
+++ toc.xml (working copy)
@@ -5,8 +5,12 @@
    <topic label="Getting Started">
       <anchor id="gettingstarted"/>
    </topic>
+ <topic label="Daily Work">
+ <anchor id="dailywork"/>
+ </topic>
    <topic label="Reference">
       <anchor id="reference"/>
    </topic>
    <topic label="FAQ" href="html/faq/faq.html"/>
+ <topic label="Subclipse for Subversion Users" href="html/faq/subversion-mapping.html"/>
 </toc>
Index: tocgettingstarted.xml
===================================================================
--- tocgettingstarted.xml (revision 1065)
+++ tocgettingstarted.xml (working copy)
@@ -6,8 +6,6 @@
                 <topic label="Setting up a Repository" href="html/gettingstarted/settingup.html" />
                 <topic label="Creating a New Repository Location" href="html/gettingstarted/new-location.html" />
         </topic>
- <topic label="Importing a Project" href="html/gettingstarted/importing.html">
- <topic label="Sharing the Project" href="html/gettingstarted/sharing.html" />
- </topic>
+ <topic label="Importing a Project" href="html/gettingstarted/importing.html"/>
         <topic label="Checking out a Project" href="html/gettingstarted/checkout.html" />
 </toc>
Index: plugin.xml
===================================================================
--- plugin.xml (revision 1065)
+++ plugin.xml (working copy)
@@ -618,6 +618,8 @@
       <toc
             file="tocreference.xml">
       </toc>
+ <toc
+ file="dailywork.xml"/>
    </extension>
    <extension
          point="org.eclipse.team.ui.synchronizeParticipants">
Index: tocreference.xml
===================================================================
--- tocreference.xml (revision 1065)
+++ tocreference.xml (working copy)
@@ -9,7 +9,9 @@
         <topic label="Commit" href="html/reference/commit.html" />
         <topic label="Resource History" href="html/reference/resource-history.html" />
         <topic label="Revert" href="html/reference/revert.html" />
+ <topic label="Mark Resolved" href="html/reference/mark-resolved.html" />
         <topic label="SVN Ignore" href="html/reference/svn-ignore.html" />
+ <topic label="SVN Annotations View" href="html/reference/svn-ignore.html" />
         <topic label="Add" href="html/reference/add.html" />
         <topic label="Compare" href="html/reference/compare.html" />
         <topic label="Pending Operations" href="html/reference/pending-operations.html" />
@@ -18,4 +20,5 @@
         <topic label="Branching" href="html/reference/branching.html" />
         <topic label="Merging" href="html/reference/merging.html" />
         <topic label="SVN Console" href="html/reference/svn-console.html" />
+
 </toc>
Index: dailywork.xml
===================================================================
--- dailywork.xml (revision 0)
+++ dailywork.xml (revision 0)
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?NLS TYPE="org.eclipse.help.toc"?>
+
+<toc label="Daily Work" link_to="toc.xml#dailywork">
+ <topic label="Edit, Update, Commit" href="html/dailywork/workcycle.html" />
+ <topic label="Using the synchronize view" href="html/dailywork/synchronize.html" />
+ <topic label="Comparing, QuickDiff and restoring" href="html/dailywork/diffing.html" />
+ <topic label="Creating and applying patches" href="html/dailywork/patches.html" />
+</toc>
Index: html/images/quickdiff-reference.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/quickdiff-reference.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/share-module-name.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/share-module-name.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/share-ready.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/share-ready.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/checkout.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/checkout.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/share-location-file.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/share-location-file.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/share-project.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/share-project.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/share-location.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/share-location.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/images/share-working-copy.jpg
===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: html/images/share-working-copy.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Index: html/dailywork/workcycle.html
===================================================================
--- html/dailywork/workcycle.html (revision 0)
+++ html/dailywork/workcycle.html (revision 0)
@@ -0,0 +1,60 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <title>Edit, Update, Commit</title>
+</head>
+
+<body>
+ <h1>Typical work cycle: Edit, Update, Commit</h1>
+
+ Often with Subversion (or most other SCM systems), once you have
+ checked out your project,
+ or shared it, you work in a simple cycle:
+
+ <ol>
+ <li>Edit</li>
+ <li>Update</li>
+ <li>Commit</li>
+ </ol>
+
+ Subclipse makes working with this cycle easy by combining the Team features in Eclipse
+ with the special features in Subversion.
+
+ <h2>Editing your working copy</h2>
+ When editing your working copy, you can observe the markings on the resource
+ (i.e. file, folder, etc.) found in the <em>Navigator</em> view (and views that are based on
+ the same information, like the Java Development Tools' <em>Package Explorer</em>.)
+
+ <p>
+ Eclipse will catch your changes and refactorings, as long as you use
+ Eclipse to work with your working copy. You may contrast this with working with the Subversion
+ command line tool which need to be told about every rename, delete and move operation that
+ you do in the working copy. Subclipse does this for you.
+
+ <p>One exception from this is adding resources: The new file(s) or folder(s) you create
+ must be added to your working copy, using the command "Add to Source Control" found in the
+ "Team" menu available in the context menu for the added resource(s).
+ If you do not do this, Subclipse will display a question mark (?) next to the resource,
+ meaning that an unknown file is present in your working copy.
+ Once added however, the resource is marked with an asterisk (*)
+
+ <p>Eventually, when you commit your changes, this marking will disappear.
+
+ <h2>Updating your working copy with other people's committed changes</h2>
+
+ <p>While your are working, editing, debugging, etc., others (if you are working in a team)
+ may commit changes to the project. To keep up, you have to update whenever you are ready
+ to do so, e.g. when your changes are stable. You should also always update immediately
+ before your commit your work.
+
+ <h2>Committing your changes to the repository</h2>
+
+ <p>Once you are pleased with all your changes, it is time to commit them to the repository.
+ Subversion will never let you commit changes that are out-of-sync, and will force you to
+ update in the event of a collision (TODO: get new image of this).
+
+</body>
+</html>
\ No newline at end of file
Index: html/dailywork/diffing.html
===================================================================
--- html/dailywork/diffing.html (revision 0)
+++ html/dailywork/diffing.html (revision 0)
@@ -0,0 +1,26 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <title>Comparing, QuickDiff and restoring</title>
+</head>
+
+<body>
+ <h1>Comparing, QuickDiff and restoring</h1>
+
+ <p>Often, you want to see what actual changes you have done. To do this, you
+ can use the "Compare With" and QuickDiff functions.
+
+ <h2>Setting the QuickDiff provider</h2>
+ It's as easy as right-clicking in the QuickDiff marker line to the immediate left of Eclipse's
+ text editor(s).
+
+ <p align="center"><img src="../images/quickdiff-reference.jpg"/></p>
+
+ Now, you can just hover the mouse over the QuickDiff marker line to see what was changed
+ locally.
+
+</body>
+</html>
\ No newline at end of file
Index: html/dailywork/patches.html
===================================================================
--- html/dailywork/patches.html (revision 0)
+++ html/dailywork/patches.html (revision 0)
@@ -0,0 +1,16 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <title>Creating and applying patches</title>
+</head>
+
+ <h1>Creating and applying patches</h1>
+<body>
+
+
+
+</body>
+</html>
\ No newline at end of file
Index: html/dailywork/synchronize.html
===================================================================
--- html/dailywork/synchronize.html (revision 0)
+++ html/dailywork/synchronize.html (revision 0)
@@ -0,0 +1,25 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <title>Using the synchronize view</title>
+</head>
+
+<body>
+ <h1>Using the synchronize view</h1>
+
+ <p>The synchronize view is useful if you want to see the overall status of your
+ working copy against the state of the repository, including any updates.
+ The view focuses on inbound and outbound changes, where <em>inbound</em> changes
+ are the changes that others have committed and are coming in to your working copy
+ when synchronizing. The <em>outbound</em> changes are the ones you did to your
+ repository as a result of editing, removing or adding resources.
+
+ <p>In short, the synchronize view offers a different way of updating and commiting
+ your work, and does so in a manner which <em>may</em> be more familar to you
+ as an Eclipse user.
+
+</body>
+</html>
\ No newline at end of file
Index: html/faq/subversion-mapping.html
===================================================================
--- html/faq/subversion-mapping.html (revision 0)
+++ html/faq/subversion-mapping.html (revision 0)
@@ -0,0 +1,145 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <title>Subclipse for Subversion Users</title>
+</head>
+
+<body>
+<h2>For Subversion users</h2>
+<p>In the following, we'll examine how Subclipse compares with the "original"
+Subversion command-line client.
+<p>TODO: These links are mostly dead/not written yet.
+
+<table border='0'>
+<tr>
+ <th><tt>svn</tt> command</th> <th>Subclipse Feature</th>
+</tr>
+<tr>
+ <td><tt>svn add</tt></td> <td>Add</td>
+</tr>
+
+<tr>
+ <td><tt>blame (praise, annotate, ann)</tt></td><td>
+ SVN Annotations View</td>
+</tr>
+
+<tr>
+ <td><tt>cat</tt></td> <td>
+ SVN Repository View</td>
+</tr>
+
+<tr>
+ <td><tt>checkout (co)</tt></td>
+ <td>
+ Check out and
+ SVN Repository View</td>
+</tr>
+
+<tr>
+ <td><tt>cleanup</tt></td><td>N/A</td>
+</tr>
+
+<tr>
+ <td><tt>commit (ci)</tt></td> <td>
+ Commit</td>
+</tr>
+
+<tr>
+ <td><tt>copy (cp)</tt></td> <td>
+ Tagging and
+ Branching</td>
+</tr>
+
+<tr>
+ <td><tt>delete (del, remove, rm)</td> <td>
+ Eclipse Refactoring hook.</td></tr>
+</tr>
+
+<tr>
+ <td><tt>diff (di)</tt></td>
+ <td>
+ Compare, and also Generate Patch.</td>
+</tr>
+
+<tr>
+ <td><tt>export</tt></td> <td>
+ Not applicable, I guess.</td>
+</tr>
+
+<tr>
+ <td><tt>import</tt></td> <td>
+ Importing</td>
+</tr>
+
+<tr>
+ <td><tt>info</tt></td> <td>
+ Found on the resource's property page.</td>
+</tr>
+
+<tr>
+ <td><tt>list (ls)</tt></td> <td>
+ SVN Repository View</td>
+</tr>
+
+<tr>
+ <td><tt>log</tt></td> <td>
+ Resource History</td>
+</tr>
+
+<tr>
+ <td><tt>merge</tt></td> <td>
+ Merging</td>
+</tr>
+
+<tr>
+ <td><tt>mkdir</tt></td> <td>
+ SVN Repository View</td>
+</tr>
+
+<tr>
+ <td><tt>move (mv, rename, ren)</tt></td> <td>
+ Eclipse Refactoring hook.</td>
+</tr>
+
+<tr>
+ <td><tt>propdel, propedit, propget, proplist, and propset</tt></td> <td>
+ SVN Properties View and SVN Ignore</td>
+</tr>
+
+<tr>
+ <td><tt>resolved</tt></td> <td>
+ Revert</td>
+</tr>
+
+<tr>
+ <td><tt>revert</tt></td> <td>
+ Mark Resolved</td>
+</tr>
+
+<tr>
+ <td><tt>status (stat, st)</tt></td> <td>
+ Pending Operations
+ Preferences</td>
+</tr>
+
+<tr>
+ <td><tt>switch (sw)</tt></td> <td>
+ Not implemented yet.</td>
+</tr>
+
+<tr>
+ <td><tt>update (up)</tt></td> <td>
+ Update
+ Merging</td>
+</tr>
+
+</table>
+
+<h3>Stuff not mentioned anywhere</h3>
+ SVN Console
+
+</body>
+</html>
\ No newline at end of file
Index: html/gettingstarted/settingup.html
===================================================================
--- html/gettingstarted/settingup.html (revision 1065)
+++ html/gettingstarted/settingup.html (working copy)
@@ -9,18 +9,27 @@
 
 <body>
 <h1>Setting up a Subversion Repository</h1>
-If you don't already have a Subversion Repository set up you will need to create one using the Subversion admin command.
-For the purposes of this quick start guide we will use file based access to the repository
+If you don't already have a Subversion Repository set up
+you will need to create one using the Subversion admin command.
+For the purposes of this quick start guide we will use file
+based access to the repository
 <ol>
- <li>Download and install the latest Subversion from <a target="new" href="http://subversion.tigris.org/project_packages.html">http://subversion.tigris.org/project_packages.html</a></il>
- <li>From the command line (and with the Subversion install in your path) run <b>svnadmin create path/to/repos</b> (eg <b>G:\>svnadmin create g:/newrepos</b> will create a new directory and repository on G drive under newrepos)</li>
+ <li>Download and install the latest Subversion from <a target="new"
+ href="http://subversion.tigris.org/project_packages.html"
+ >http://subversion.tigris.org/project_packages.html</a></il>
+ <li>From the command line (and with the Subversion install in your
+ path) run <tt>svnadmin create <i>path/to/repos</i></tt> (e.g.
+ <tt>g:\>svnadmin create <b>g:/newrepos</b></tt> will create a new
+ directory and repository on your G drive, named <tt>newrepos</tt>.)</li>
 </ol>
 <p>
 You should now have a repository structure similar to this ...
 </p>
 <p align="center"><img src="../images/repos-layout.jpg"/></p>
 
-Check out <a target="new" href="http://svnbook.red-bean.com/">http://svnbook.red-bean.com/</a> for more details on setting up HTTP and other based repository access
+Check out the book <a target="new" href="http://svnbook.red-bean.com/"><em>Version
+Control with Subversion</em></a> for more details on setting up HTTP and other
+types of repository access. The book is also available in print.
 
 </body>
 </html>
\ No newline at end of file
Index: html/gettingstarted/checkout.html
===================================================================
--- html/gettingstarted/checkout.html (revision 1065)
+++ html/gettingstarted/checkout.html (working copy)
@@ -9,10 +9,13 @@
 
 <body>
 <h1>Checking out a Project</h1>
-Delete the previously shared project from your workspace so you can check out a fresh version.
-<br><br>
 Navigate to the <b>SVN Perspective</b> and expand out the previously created repository location.
 <br><br>
-<b>Right click</b> on the created project and select <b>Check Out As Project</b> and this will check out the project into your workspace ready to use
-</body>
+<b>Right click</b> on the project in the repository and select <b>Check Out As Project</b> and this will
+check out the project into your workspace ready to use. Subclipse will attempt to use the same name as
+the Eclipse project in the repository (if stored in the <tt>.project</tt> file).</p>
+<p align="center"><img src="../images/checkout.jpg" alt="Checking out an Eclipse project from a Subversion repository"/></p>
+
+<p>Once the project is checked out, you can switch to a different perspective and start working.
+The Team menu will automatically use the Subversion repository location for comparisons, updates, etc.</body>
 </html>
\ No newline at end of file
Index: html/gettingstarted/connecting.html
===================================================================
--- html/gettingstarted/connecting.html (revision 1065)
+++ html/gettingstarted/connecting.html (working copy)
@@ -14,8 +14,15 @@
 <br>
 <p align="center"><img src="../images/select-perspective.jpg"/></p>
 <br>
-It is in this perspective that you can create connections to various Subversion Repositories, and manipulate remote resources for tagging and branching.
+It is in this perspective that you can create connections to various Subversion Repositories,
+and manipulate remote resources for tagging and branching.
 <br>
 <p align="center"><img src="../images/svn-explorer-perspective.jpg"/></p>
+
+<h1>If you already are using Subversion</h1>
+If you are already working with a working copy, you still need to Eclipse know that
+the Subversion working-copy housekeeping is already in place. You can do this by
+select the project you want to import and right click to select
+<b>Team->Share Project...</b>.
 </body>
 </html>
\ No newline at end of file
Index: html/gettingstarted/sharing.html
===================================================================
--- html/gettingstarted/sharing.html (revision 1065)
+++ html/gettingstarted/sharing.html (working copy)
@@ -1,14 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
- <title>Connecting to a Subversion Repository</title>
-</head>
-
-<body>
-<h1>Main Topic</h1>
-Please enter your text here.
-</body>
-</html>
\ No newline at end of file
Index: html/toc.html
===================================================================
--- html/toc.html (revision 1065)
+++ html/toc.html (working copy)
@@ -3,24 +3,37 @@
 <html>
 <head>
         <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <title>Table of Contents</title>
+ <title>Subclipse Help - Table of Contents</title>
 </head>
 
 <body>
 <h1>A Quick Start Guide and Reference</h1>
-The <b>Getting Started</b> section will take you through the basics of the Subclipse Eclipse plugin for Subversion such as..
+The <b>Getting Started</b> section will take you through the basics of the Subclipse Eclipse plugin for Subversion such as...
 <ul>
 <li>Creating a Repository</li>
 <li>Connecting Eclipse to the repository</li>
 <li>Importing a new project into the respoitory</li>
 <li>Checking out a project from a repository into your Eclipse workspace</li>
+<li>Using an existing Subversion working copy with Subclipse</li>
 </ul>
 
+
+The section on <b>Daily Work</b> focuses on the day-to-day tasks:
+<ul>
+<li>Editing</li>
+<li>Updating</li>
+<li>Committing your work</li>
+<li>Synchronizing with the repository (using the Synchronize View)</li>
+</ul>
+
 <p>
 The <b>Reference</b> section will take you through each feature the plug-in provides
 </p>
 <p>
-The <b>FAQ</b> section provides some quick answers to all the common questions
+The <b>FAQ</b> section provides some quick answers to some of the common questions
 </p>
+<p>However, if you are already a Subversion user, then the feature-by-feature comparison
+of the Subversion client (command line) and Subclipse may give you the best
+starting point.
 </body>
 </html>
\ No newline at end of file
Received on Thu Nov 18 00:34:07 2004

This is an archived mail posted to the Subclipse Dev mailing list.