Differences between revisions 5 and 27 (spanning 22 versions)
Revision 5 as of 2015-07-28 10:17:25
Size: 844
Editor: ZekeKaufman
Comment:
Revision 27 as of 2016-12-08 14:08:29
Size: 3222
Editor: ZekeKaufman
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Checkout out the main branch:
||'''cvs'''||{{{cvs checkout dev}}}||
||'''git'''||{{{git clone /space/freesurfer/repo/freesurfer}}}||
#acl LcnGroup:read,write,delete,revert All:
Line 6: Line 4:
Checkout the stable branch:
||'''cvs'''||{{{cvs checkout -r stable6 dev}}}||
||'''git'''||{{{git clone -b stable6 /space/freesurfer/repo/freesurfer}}}||
This page is provided for !FreeSurfer developers to assist in the CVS -> git transition.

This page is not meant to be a comprehensive guide for using git. Git is a feature loaded version control system which at times can be a bit of a hurdle to learn. The following site However, when used in its simplest form it is very similar to most all other version control systems, including CVS. Below are many of the basic CVS commands used by !FreeSurfer developers the git equivalent of that command. The [[https://www.atlassian.com/git/tutorials/what-is-git|Atlassian]] and [[https://git-scm.com/doc|git-scm]] are great resources for those who want to dig deeper and and learn more about git and its features.


== Initial Git Setup ==

When we start out using git we want to set a few of our configuration settings. We only need to do this one time:
{{{
$> cd ~
$> git config --global user.name "Zeke Kaufman"
$> git config --global user.email zkaufman@nmr.mgh.harvard.edu
}}}
For additional examples of git specifics setting (e.g. default editor, color settings), see the following page: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration

== Checkout out the main branch ==
When working with CVS, we would checkout out the !FreeSurfer repository using the '''{{{cvs checkout dev}}}''' command. In git we 'clone' repositories. This gives us a local version of the repository which we can work with:
{{{
$> git clone /space/freesurfer/repo/freesurfer
}}}



If you wanted to check out a specific branch, you could do that in a couple different ways:
{{{
$> git clone /space/freesurfer/repo/freesurfer
$> cd freesurfer
$> git checkout stable6

or,

$> git clone -b stable6 /space/freesurfer/repo/freesurfer
}}}

Additional examples:
[[https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository#Cloning-an-Existing-Repository|Cloning-an-Existing-Repository]]

[[https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone|git-clone]]

== Daily Workflow ==
Line 13: Line 49:
||{{{git push .}}}|| ||{{{git push}}}||
Line 15: Line 51:
Commit a modified data file: Modify and commit a data file:
Line 17: Line 53:
||<|3>'''git'''||{{{git annex unlock <file_name>}}}|| ||<|5>'''git'''||{{{git annex unlock <file_name>}}}||
||{{{git annex add <file_name>}}}||
Line 19: Line 56:
||{{{git push}}}||
Line 21: Line 59:
Add a data file:
||<|2>'''cvs'''||{{{cvs add <file_name>}}}||
||{{{cvs commit <file_name>}}}||
||<|4>'''git'''||{{{git annex add <file_name>}}}||
||{{{git commit <file_name>}}}||
||{{{git push}}}||
||{{{git annex copy --to origin <file_name>}}}||


Remove data file:
||<|3>'''cvs'''||{{{rm <file_name>}}}||
||{{{cvs rm <file_name>}}}||
||{{{cvs commit -m "Removing <file_name>" <file_name>}}}||
||<|2>'''git'''||{{{git rm <file_name>}}}||
||{{{git commit -m "Removing <file_name>" <file_name>}}}||
Line 22: Line 76:
||{{{git reset --soft HEAD~1}}}|| ||'''git'''||{{{git reset --soft HEAD~1}}}||
Line 24: Line 78:
||{{{git reset --soft HEAD~2}}}|| ||'''git'''||{{{git reset --soft HEAD~2}}}||

This page is provided for FreeSurfer developers to assist in the CVS -> git transition.

This page is not meant to be a comprehensive guide for using git. Git is a feature loaded version control system which at times can be a bit of a hurdle to learn. The following site However, when used in its simplest form it is very similar to most all other version control systems, including CVS. Below are many of the basic CVS commands used by FreeSurfer developers the git equivalent of that command. The Atlassian and git-scm are great resources for those who want to dig deeper and and learn more about git and its features.

Initial Git Setup

When we start out using git we want to set a few of our configuration settings. We only need to do this one time:

$> cd ~
$> git config --global user.name "Zeke Kaufman"
$> git config --global user.email zkaufman@nmr.mgh.harvard.edu

For additional examples of git specifics setting (e.g. default editor, color settings), see the following page: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration

Checkout out the main branch

When working with CVS, we would checkout out the FreeSurfer repository using the cvs checkout dev command. In git we 'clone' repositories. This gives us a local version of the repository which we can work with:

$> git clone /space/freesurfer/repo/freesurfer

If you wanted to check out a specific branch, you could do that in a couple different ways:

$> git clone /space/freesurfer/repo/freesurfer
$> cd freesurfer
$> git checkout stable6

or,

$> git clone -b stable6 /space/freesurfer/repo/freesurfer

Additional examples: Cloning-an-Existing-Repository

git-clone

Daily Workflow

Commit a modified source code file:

cvs

cvs commit -m "Added new capabilities." <file_name>

git

git commit -m "Added new capabilities." <file_name>

git push

Modify and commit a data file:

cvs

cvs commit <file_name>

git

git annex unlock <file_name>

git annex add <file_name>

git commit <file_name>

git push

git annex copy --to origin <file_name>

Add a data file:

cvs

cvs add <file_name>

cvs commit <file_name>

git

git annex add <file_name>

git commit <file_name>

git push

git annex copy --to origin <file_name>

Remove data file:

cvs

rm <file_name>

cvs rm <file_name>

cvs commit -m "Removing <file_name>" <file_name>

git

git rm <file_name>

git commit -m "Removing <file_name>" <file_name>

Undo 1 commit (before push):

git

git reset --soft HEAD~1

Undo 2 commits:

git

git reset --soft HEAD~2