Slicer3:Contributing codes to Slicer3 - Revision history

Pieper: /* Objective */

2010-11-16T18:07:42Z

Objective

Nicole at 20:00, 11 February 2010

2010-02-11T20:00:01Z

Pieper: /* Objective */

2010-01-21T13:29:24Z

Objective

Pieper: /* Objective */

2010-01-21T13:28:02Z

Objective

Nicole: /* How to obtain Slicer 3 code from SVN */

2008-11-18T18:26:00Z

How to obtain Slicer 3 code from SVN

Marianna at 17:46, 19 May 2008

2008-05-19T17:46:35Z

Marianna: /* How to commit codes */

2008-05-19T17:45:55Z

How to commit codes

Marianna: 1 revision

2008-05-15T17:59:23Z

1 revision

Noby: /* How to commit codes */

2007-01-26T17:52:25Z

How to commit codes

New page

=Objective=
The goal of this page is to give quick instruction to download Slicer3 from Subversion Control (SVN) server, and contribute codes by committing them back to SVN.

== How to obtain Slicer 3 codes from SVN ==

The Slicer3 svn repository sits in a server at Brigham and Women's Hospital in Boston. You can checkout codes by:

svn co http://www.na-mic.org/svn/Slicer3/trunk Slicer3

'''You don't need to obtain an account discussed below''' if you don't commit codes back to the sever, but we enthusiastically invite you to do so.

== How to commit codes ==

First, fill the form at https://www.kitware.com/Admin/SendPassword.cgi and under Comment type "Request password for Slicer". Once you have access to write to SVN, you can work with repository using the following commands:

To update repository:

svn update

To check current state of your edits:

svn status

To check the current state compared to the repository:

svn -u status

To add new file:

svn add filename

followed by (very important):

svn commit -m"ENH: Adding a new file" filename

To remove file:

svn remove filename

To rename file:

svn move oldname newname

If the update results in conflict, fix the file first before commiting it.

Once you have fixed the file:

svn resolved <filename>

==GUI tools for eash SVN handling==
It is handy to use GUI tool for SVN. I particulary like a cross-platform GUI tool called [http://rapidsvn.tigris.org/ RapidSVN].

← Older revision		Revision as of 18:07, 16 November 2010
Line 8:		Line 8:
	See [http://www.na-mic.org/Wiki/index.php/Engineering:Subversion_Repository this page for more information about subversion].		See [http://www.na-mic.org/Wiki/index.php/Engineering:Subversion_Repository this page for more information about subversion].

		+	See also this information on using [[Slicer3:git-svn\|git's interface to svn for slicer3 development]].

	== How to obtain Slicer 3 code from SVN ==		== How to obtain Slicer 3 code from SVN ==

@@ Line 1: / Line 1: @@
 =Objective=
-The goal of this page is to give quick instruction to download Slicer3 from Subversion Control (SVN) server, and contribute codes by committing them back to SVN.
+The goal of this page is to give quick instructions on how to download Slicer3 from the Subversion Control (SVN) server, and contribute code by committing changes back to SVN. More general instructions for developers are available [http://slicer.org/pages/DeveloperOrientation here].
-If you are interested in contributing to slicer, please contact the slicer-devel [http://www.slicer.org/pages/Mailinglist mailing list] with information about what you have in mind.
+If you are interested in contributing to Slicer3, please contact the slicer-devel [http://www.slicer.org/pages/Mailinglist mailing list] with information about what you have in mind.
 Also, consider using the [[Slicer3:Extensions|extension mechanism]] to prototype new functionality.
@@ Line 11: / Line 11: @@
 == How to obtain Slicer 3 code from SVN ==
-The Slicer3 svn repository sits in a server at Brigham and Women's Hospital in Boston. You can checkout codes by:
+The Slicer3 svn repository sits on a server at Brigham and Women's Hospital in Boston. You can check out code to your local machine by:
   svn co http://svn.slicer.org/Slicer3/trunk Slicer3
-'''You don't need to obtain an account discussed below''' if you don't commit code back to the sever, but we enthusiastically invite you to do so.
+'''You don't need to obtain an account discussed below''' if you don't intend to commit code back to the sever, but we enthusiastically invite you to do so.
-== How to commit codes ==
+== How to commit code ==
-First, fill this [https://www.kitware.com/Admin/SendPassword.cgi form] and under Comment type '''''Request password for Slicer'''''.  Once you have access to write to SVN, you can work with repository using the following commands:
+First, fill this [https://www.kitware.com/Admin/SendPassword.cgi form] and under Comment type '''''Request password for Slicer'''''.  Once you have write access to SVN, you can work with the repository using the following commands:
-To update repository:
+To update your local copy from the repository:
   svn update
-To check current state of your edits:
+To check the current state of your local copy:
   svn status
@@ Line 33: / Line 33: @@
   svn -u status
-To add new file:
+To add a new file, first register it with the repository:
   svn add filename
-followed by (very important):
+and then (very important):
-  svn commit -m"ENH: Adding a new file" filename
+  svn commit -m "ENH: Adding a new file for X" filename
-To remove file:
+To remove a file:
   svn remove filename
-To rename file:
+To rename a file:
-  svn move oldname newname
+  svn move oldfilename newfilename
-If the update results in conflict, fix the file first before commiting it.
+If the update results in a conflict, fix the file first before commiting it.
 Once you have fixed the file:
-  svn resolved <filename>
+  svn resolved filename
-==GUI tools for eash SVN handling==
+==GUI tools for easy SVN handling==
 It is handy to use GUI tool for SVN. I particulary like a cross-platform GUI tool called [http://rapidsvn.tigris.org/ RapidSVN].

← Older revision		Revision as of 13:29, 21 January 2010
Line 5:		Line 5:

	Also, consider using the [[Slicer3:Extensions\|extension mechanism]] to prototype new functionality.		Also, consider using the [[Slicer3:Extensions\|extension mechanism]] to prototype new functionality.
		+
		+	See [http://www.na-mic.org/Wiki/index.php/Engineering:Subversion_Repository this page for more information about subversion].

← Older revision		Revision as of 13:28, 21 January 2010
Line 1:		Line 1:
	=Objective=		=Objective=
	The goal of this page is to give quick instruction to download Slicer3 from Subversion Control (SVN) server, and contribute codes by committing them back to SVN.		The goal of this page is to give quick instruction to download Slicer3 from Subversion Control (SVN) server, and contribute codes by committing them back to SVN.
		+
		+	If you are interested in contributing to slicer, please contact the slicer-devel [http://www.slicer.org/pages/Mailinglist mailing list] with information about what you have in mind.
		+
		+	Also, consider using the [[Slicer3:Extensions\|extension mechanism]] to prototype new functionality.

@@ Line 13: / Line 13: @@
 == How to commit codes ==
-First, fill this [https://www.kitware.com/Admin/SendPassword.cgi form] and under Comment type "Request password for Slicer".  Once you have access to write to SVN, you can work with repository using the following commands:
+First, fill this [https://www.kitware.com/Admin/SendPassword.cgi form] and under Comment type '''''Request password for Slicer'''''.  Once you have access to write to SVN, you can work with repository using the following commands:
 To update repository:

← Older revision	Revision as of 17:59, 15 May 2008
(No difference)