|
Size: 1608
Comment:
|
Size: 2935
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| == Initial Git Setup (just do once) == | #acl LcnGroup:read,write,delete,revert All: |
| Line 3: | Line 3: |
| Configuration settings: | 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: |
| Line 5: | Line 13: |
| $> git config --global user.name "John Doe" $> git config --global user.email johndoe@nmr.mgh.harvard.edu |
$> cd ~ $> git config --global user.name "Zeke Kaufman" $> git config --global user.email zkaufman@nmr.mgh.harvard.edu |
| Line 8: | Line 17: |
| 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 | |
| Line 9: | Line 19: |
| Checkout out the main branch: | == 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: |
| Line 11: | Line 22: |
| Line 13: | Line 23: |
| (remotely) $> $> cvs checkout dev |
|
| Line 23: | Line 29: |
| $> git clone -b stable6 /space/freesurfer/repo/freesurfer | $> git clone /space/freesurfer/repo/freesurfer $> cd freesurfer $> git checkout stable6 |
| Line 25: | Line 33: |
| $> cvs checkout -r stable6 dev | or, $> git clone -b stable6 /space/freesurfer/repo/freesurfer <optional_directory_name> |
| Line 34: | Line 44: |
| ||{{{git push .}}}|| | ||{{{git push}}}|| |
| Line 38: | Line 48: |
| ||<|4>'''git'''||{{{git annex unlock <file_name>}}}|| | ||<|5>'''git'''||{{{git annex unlock <file_name>}}}|| |
| Line 41: | Line 51: |
| ||{{{git push}}}|| | |
| Line 48: | Line 59: |
| ||{{{git push .}}}|| | ||{{{git push}}}|| |
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
Checkout the stable branch:
$> git clone /space/freesurfer/repo/freesurfer $> cd freesurfer $> git checkout stable6 or, $> git clone -b stable6 /space/freesurfer/repo/freesurfer <optional_directory_name>
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 |