Documentation/Nightly/Developers/DevelopmentWithGit - Revision history

JChris.FillionR at 05:12, 24 March 2020

2020-03-24T05:12:58Z

Max.smolens: Note error in pre-commit hook in msysgit

2015-08-21T21:00:27Z

Note error in pre-commit hook in msysgit

Nicole at 19:46, 26 March 2014

2014-03-26T19:46:07Z

JChris.FillionR at 16:03, 14 June 2013

2013-06-14T16:03:46Z

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T08:02:34Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Pieper: /* Slicer Setup */

2013-04-24T21:42:40Z

Slicer Setup

Sankhesh.jhaveri: /* Development with Git */

2013-04-24T16:03:16Z

Development with Git

Sankhesh.jhaveri at 15:55, 24 April 2013

2013-04-24T15:55:39Z

Sankhesh.jhaveri: /* Slicer Setup */

2013-04-24T15:50:55Z

Slicer Setup

Sankhesh.jhaveri: /* commit-msg */

2013-04-24T15:48:19Z

commit-msg

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
-= Development with Git =
+=Development with Git=
 '''This page helps developers in the migration of Slicer4 from subversion to git.'''
 ''See also:''[[Slicer:git-svn | Instructions for setting up a git repository to interact with Slicer's svn]]
 ==Git==
 <i>
@@ Line 16: / Line 16: @@
 Please see our [[Documentation/Nightly/Developers/Git/Resources | Git resource links]] for third party documentation, such as the [http://progit.org/book/ ProGit Book].
-== Slicer Setup ==
+==Slicer Setup==
 . Follow instructions on [[Documentation/Nightly/Developers/StartHere|Start Here]] page to clone the Slicer repo from Github.
@@ Line 26: / Line 26: @@
 The [https://github.com/Slicer/Slicer/blob/master/Utilities/SetupForDevelopment.sh SetupForDevelopment.sh] script will setup git user info and git hooks.
-== Git Hooks ==
+==Git Hooks==
 * Hooks are stored in the main Slicer4 repository under a separate branch called [https://github.com/Slicer/Slicer/tree/hooks hooks].
-* These hooks are pulled when the SetupForDevelopment script is run. They are placed in the .git/hooks directory to install them.
+*Hooks are stored in the main Slicer4 repository under a separate branch called [https://github.com/Slicer/Slicer/tree/hooks hooks].
-* The following local hooks are currently installed. See Git help on [http://www.kernel.org/pub/software/scm/git/docs/githooks.html githooks] for more details.
+*These hooks are pulled when the SetupForDevelopment script is run. They are placed in the .git/hooks directory to install them.
-=== pre-commit ===
+===pre-commit===
 This runs during <code>git commit</code> before the commit message editor is fired up.  It checks the identity and content of changes:
-* Git <code>user.name</code> and <code>user.email</code> are set to something reasonable
+*Git <code>user.name</code> and <code>user.email</code> are set to something reasonable
-* Git's standard whitespace checks (see help on <code>git diff --check</code>)
+*Git's standard whitespace checks (see help on <code>git diff --check</code>)
-* The staged changes do not introduce any leading TABs in source files (we indent with spaces)
+*The staged changes do not introduce any leading TABs in source files (we indent with spaces)
-* File modes look reasonable (no executable .cxx files, scripts with shebang lines are executable)
+*File modes look reasonable (no executable .cxx files, scripts with shebang lines are executable)
-* File size is not too large (don't commit big data files; prints limit and instructions on rejection)
+*File size is not too large (don't commit big data files; prints limit and instructions on rejection)
-* Files do not have very long lines (longer than 160 characters).
+*Files do not have very long lines (longer than 160 characters).
 One of Git's standard whitespace checks is to reject ''trailing'' whitespace on lines that were added or modified.<br />
@@ Line 49: / Line 50: @@
 {|
 |-
-|width=20%|Emacs
+| width="20%" |Emacs
+|
   (custom-set-variables '(show-trailing-whitespace t))
-|align="center"|
+| align="center" |
 [http://www.vtk.org/Wiki/Elisp_Code_for_VTK-Style_C_Indentation <code>Emacs configuration file</code>]
 |-
-|width=20%|Vim
+| width="20%" |Vim
+|
   :highlight ExtraWhitespace ctermbg=red guibg=red
   :match ExtraWhitespace /\s\+$/
 |-
-|width=20%|Visual Studio
+| width="20%" |Visual Studio
+|
   To toggle viewing of white space characters, with a source
@@ Line 69: / Line 70: @@
   (2-stroke keyboard shortcut: '''Ctrl+R, Ctrl+W''')
 |-
-|width=20%|Notepad++ (v5.6.7)
+| width="20%" |Notepad++ (v5.6.7)
+|
   To eliminate trailing white space, choose the menu item:
@@ Line 81: / Line 82: @@
 |}
-* Note that Git Bash from msysgit on Windows gives errors when running the pre-commit hook:
+*Note that Git Bash from msysgit on Windows gives errors when running the pre-commit hook:
      .git/hooks/pre-commit: command substitution: line 210: conditional binary operator expected
@@ Line 89: / Line 90: @@
 See http://stackoverflow.com/questions/15510083/syntax-error-operator-in-msysgit-bash.
-=== commit-msg ===
+===commit-msg===
 This runs during <code>git commit</code> after the commit message is saved.  It checks the commit message format:
-* The first line must be between 8 and 78 characters long.  If you were writing an email to describe the change, this would be the Subject line.
+*The first line must be between 8 and 78 characters long.  If you were writing an email to describe the change, this would be the Subject line.
-* The first line must not have leading or trailing whitespace.
+*The first line must not have leading or trailing whitespace.
-* NA-MIC/Slicer4 requires commit messages to start with a commit type. Valid commit types are:
+*NA-MIC/Slicer4 requires commit messages to start with a commit type. Valid commit types are:
     BUG:   - a change made to fix a runtime issue
              (crash, segmentation fault, exception, or incorrect result,
@@ Line 104: / Line 106: @@
              (improve coding style, comments, documentation).
 Note that the ':'(colon) directly follows the commit tag. For example, it is: "STYLE:" not "STYLE :"
-* GUI and text-based tools that help view history typically use the first line (Subject line) from the commit message to give a one-line summary of each commit.
+*The second line must be blank, if present.
 :This allows a medium-level view of history, but works well only if developers write good Subject lines for their commits.
-: Examples of ''improper'' commit messages:
+:Examples of ''improper'' commit messages:
   Fixed
@@ Line 120: / Line 124: @@
 :This is too long and defeats the purpose of a Subject line.
-: A good commit message would look something like this:
+:A good commit message would look something like this:
    BUG: Fixed improper referencing of pointers
-* Further adding the Mantis issue number to the commit message is good practice. This helps checking the history of the issue on Mantis and knowing why the change was done in the first place.
+*Further adding the Mantis issue number to the commit message is good practice. This helps checking the history of the issue on Mantis and knowing why the change was done in the first place.
 :This is probably because in CVS it is hard to abort a commit if it already brought up the message editor.<br />
 :In Git this is trivial.  Just leave the message blank and the whole commit will be aborted.<br />
 :Furthermore, since commits are not published automatically it is easy to allow the commit to complete and then fix it with <code>git commit --amend</code>.<br />
-== Further Work ==
+==Further Work==
 * Setting up a master/next git development workflow similar to that followed by large open source projects such as [http://git.kernel.org/cgit/git/git.git/refs/?id=refs/heads/master git.git], [http://paraview.org/gitweb?p=ParaView.git;a=heads ParaView]. A good description on this model is provided [http://nvie.com/posts/a-successful-git-branching-model/ here].
-* Setting up Git aliases for better management of push/pull requests
+*Setting up a master/next git development workflow similar to that followed by large open source projects such as [http://git.kernel.org/cgit/git/git.git/refs/?id=refs/heads/master git.git], [http://paraview.org/gitweb?p=ParaView.git;a=heads ParaView]. A good description on this model is provided [http://nvie.com/posts/a-successful-git-branching-model/ here].
-* Possible gerrit integration
+*Setting up Git aliases for better management of push/pull requests

@@ Line 80: / Line 80: @@
    '''View > Show Symbol >''' (multiple items, choose one...)
 |}
 === commit-msg ===

@@ Line 27: / Line 27: @@
 == Git Hooks ==
-* Hooks are stored in the main Slicer4 repository under a separate branch called [https://github.com/sankhesh/Slicer/tree/hooks hooks].
+* Hooks are stored in the main Slicer4 repository under a separate branch called [https://github.com/Slicer/Slicer/tree/hooks hooks].
 * These hooks are pulled when the SetupForDevelopment script is run. They are placed in the .git/hooks directory to install them.
 * The following local hooks are currently installed. See Git help on [http://www.kernel.org/pub/software/scm/git/docs/githooks.html githooks] for more details.

← Older revision		Revision as of 16:03, 14 June 2013
Line 21:		Line 21:
	2. Run the developer setup script to set up your Slicer work tree		2. Run the developer setup script to set up your Slicer work tree

−	$ ./Utilities/SetupForDevelopment.sh~~</code>~~	+	$ ./Utilities/SetupForDevelopment.sh

← Older revision		Revision as of 08:02, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	= Development with Git =		= Development with Git =
	'''This page helps developers in the migration of Slicer4 from subversion to git.'''		'''This page helps developers in the migration of Slicer4 from subversion to git.'''

@@ Line 2: / Line 2: @@
 '''This page helps developers in the migration of Slicer4 from subversion to git.'''
-For now, see the [[Slicer:git-svn| instructions for setting up a git repository to interact with slicer's svn]].
 == Git ==

@@ Line 29: / Line 29: @@
 |-
+|
-This script will setup git user info and git hooks.
+:This script will setup git user info and git hooks.
+|
 |}