Documentation/Nightly/Developers/Build system/Remote Module - Revision history

Inorton: Add note about Slicer_Remote_Add

2015-03-26T21:59:34Z

Add note about Slicer_Remote_Add

2014-05-20T13:54:05Z

Policy for Adding Remote Modules

2014-05-20T03:35:55Z

Procedure for Updating a Remote Module

2013-12-17T07:35:45Z

Purpose of Remote Modules

2013-12-17T07:35:13Z

2013-12-17T07:34:50Z

Policy for Adding and Removing Remote Modules

2013-12-17T07:00:59Z

Procedure for Adding a Remote Module

2013-12-17T06:57:43Z

Procedure for Adding a Remote Module

2013-12-17T06:56:29Z

Procedure for Adding a Remote Module

2013-12-17T06:54:24Z

Procedure for Adding a Remote Module

← Older revision		Revision as of 21:59, 26 March 2015
Line 53:		Line 53:

	<p>Additionally, by specifying the <code>REMOTE_MODULE</code> label, within <code>Slicer/Modules/Remote/CMakeLists.txt</code>, the corresponding source directory will automatically be added using a call to <code>add_directory</code>.</p>		<p>Additionally, by specifying the <code>REMOTE_MODULE</code> label, within <code>Slicer/Modules/Remote/CMakeLists.txt</code>, the corresponding source directory will automatically be added using a call to <code>add_directory</code>.</p>
		+
		+	'''Note:''' <code>Slicer_Remote_Add</code> creates an in-source module target within <code>Slicer/Modules/Remote</code>. The SuperBuild target for a remote module only runs the source update step; there is no separate build step.

	= Procedure for Updating a Remote Module =		= Procedure for Updating a Remote Module =

← Older revision		Revision as of 13:54, 20 May 2014
Line 16:		Line 16:

	At no time in the future should a module in the main Slicer repository depend on Remote module.		At no time in the future should a module in the main Slicer repository depend on Remote module.
		+
		+	Remote modules MUST define a specific '''unique''' revision (git hash or svn revision). It is important for debugging and scientific reproducibility that there be a unique set of code associated with each slicer revision.

	= Procedure for Adding a Remote Module =		= Procedure for Adding a Remote Module =

@@ Line 54: / Line 54: @@
 = Procedure for Updating a Remote Module =
-. Update the entry into <code>SuperBuild.cmake</code
+. Update the entry into <code>SuperBuild.cmake</code>
 . Commit with a message similar to:

@@ Line 3: / Line 3: @@
 Keep the Slicer core lean.
-Allow individuals or organizations to work on their own private modules and optionally make these modules available to the Slicer users as without the need to use the extensions manager.
+Allow individuals or organizations to work on their own private modules and optionally make these modules available to the Slicer users without the need to use the extensions manager.
 = Policy for Adding Remote Modules =

← Older revision		Revision as of 07:35, 17 December 2013
Line 6:		Line 6:


−	= Policy for Adding ~~and Removing~~ Remote Modules =	+	= Policy for Adding Remote Modules =

	Module is known to compile on Linux, MacOSX and Windows.		Module is known to compile on Linux, MacOSX and Windows.

@@ Line 11: / Line 11: @@
 Module is tested.
 Module names must be unique.
 At no time in the future should a module in the main Slicer repository depend on Remote module.
 = Procedure for Adding a Remote Module =

@@ Line 27: / Line 27: @@
 <li>
-   <p>Add an entry into <code>SuperBuild.cmake</code> using <code>Slicer_Remote_Add()</code> macro. For example:</p>
+   <p>Add an entry into <code>SuperBuild.cmake</code> using [https://github.com/Slicer/Slicer/blob/master/CMake/ExternalProjectAddSource.cmake#L33-45 Slicer_Remote_Add()] macro. For example:</p>
 <pre>

@@ Line 31: / Line 31: @@
 <pre>
 Slicer_Remote_Add(Foo
-   GIT_REPOSITORY git://github.com/john/foo
+   GIT_REPOSITORY ${git_protocol}://github.com/john/foo
    GIT_TAG abcdef
    OPTION_NAME Slicer_BUILD_Foo

@@ Line 36: / Line 36: @@
    LABELS REMOTE_MODULE
+   )
 </pre>
 </li>

← Older revision		Revision as of 06:54, 17 December 2013
Line 49:		Line 49:

	</ol>		</ol>
		+
		+	<p>As a side effect of calling <code>Slicer_Remote_Add</code>, the option <code>Slicer_BUILD_Foo</code> will automatically be added as an advanced option and (2) the CMake variables <code>Slicer_BUILD_Foo</code> and <code>Foo_SOURCE_DIR</code> will be passed to Slicer inner build.</p>
		+
		+	<p>Additionally, by specifying the <code>REMOTE_MODULE</code> label, within <code>Slicer/Modules/Remote/CMakeLists.txt</code>, the corresponding source directory will automatically be added using a call to <code>add_directory</code>.</p>

	= Procedure for Updating a Remote Module =		= Procedure for Updating a Remote Module =