% git-demo % Nicolas Borboën <nicolas.borboen@epfl.ch> % 2015-09-14

<!-- ===================================================================

               _ _             _
              (_) |           | |
          __ _ _| |_ ______ __| | ___ _ __ ___   ___  
         / _` | | __|______/ _` |/ _ \ '_ ` _ \ / _ \
        | (_| | | |_      | (_| |  __/ | | | | | (_) |
         \__, |_|\__|      \__,_|\___|_| |_| |_|\___/
          __/ |
         |___/

$ git clone https://gitlab.epfl.ch/sti-it/git-demo.git

To generate the PDF file please use this pandoc command
  $ pandoc --toc -V documentclass=report -o README.pdf README.md

=================================================================== -->

Git-demo project

The aim of this repo is to provide a simple tutorial about git usage. You will need git^[Information about installing git on your system can be found here: https://git-scm.com/download/] and a merge tool^Many merge tool are available but [Meld is a good multi-plateforme candidate].

Define your git public informations

1. Set you username
   
   $ git config --global user.name "Your Name Comes Here"

1. Set you email
   
   $ git config --global user.email you@yourdomain.example.com

Basics commands

This section present all the "every day" git commands. How to clone a git repository locally, add files, commit changes, push to repository and pull from repository.

1. Create a projet on gitlab.epfl.ch / github.com or initialize a local project with the command
   
   $ git init

1. Clone the project on your computer
   
   $ git clone username@host:/path/to/repository
   
   $ git clone https://gitlab.epfl.ch/sti-it/git-demo.git

1. Edit the file foo.md

1. Commit your modification
   
   $ git commit -m "My modifications details" foo.md

1. Create a new file
   
   $ vim myTestFile.txt

1. Add the new file to git
   
   $ git add myTestFile.txt
   
   and commit it.

1. Check your modification
   
   $ git status

1. Push your modification
   
   $ git push

1. Browse to the repository page to see the modification

1. Others collaborators of the repository can now update their files to see your changes with
   
   $ git pull

1. 1. Read the log
2. View all the logs
   
   git log

1. View the log of a specified author
   
   git log --author=bob

1. Test some logs option
   
   git log --pretty=oneline
   
   git log --graph --oneline --decorate --all
   
   git log --name-status
   
   git log --help

1. Note that you can use the following command to search for strings in any version of your project:
   
   $ git grep "hello"

1. 1. Conflicts management
2. Reset changes you made to a file
   
   $ git checkout -- <filename>

1. Set the tool you want to use to resolve conflict
   
   $ git mergetool

1. Resets any changes to tracked files:
   
   $ git reset --hard origin/master
   
   Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded.

1. If you want to be more delicate than the latest command, you can use:
   
   $ git revert <commit>
   
   Reverting has important advantages over resetting as it doesn’t change the project history, which makes it a “safe” operation for commits that have already been published to a shared repository.

1. 1. Managing branches
2. Create a new branch
   
   $ git branch myTest

1. List the branches of your project
   
   $ git branch
   
   myTest master* (<-- current branch)

1. Change the branch with the command
   
   $ git checkout myTest

1. Now edit the foo.md file and commit it, then change back on master branch
   
   $ git checkout master
   
   Check that the change you made is no longer visible, since it was made on the myText branch and you’re back on the master branch.

1. Now you can edit files on the master branch, but at one point you may want to bring back the changes made on myTest to master branch:
   
   $ git merge myTest
   
   If the changes don’t conflict, you’re done. If there are conflicts, markers will be left in the problematic files showing the conflict.

1. Check the markers with the diff command:
   
   $ git diff

1. Now edit the file to resolve the conflicts and commit the changes made to the file. You can use the tool "gitk" to graphically see the resulting history.
   
   $ gitk

1. As the changes made to the myTest branch are now merged, you can delete this branch:
   
   $ git branch -d myTest

1. 1. Cleaning up
2. Remove branches
   
   $ git branch
   
   and
   
   $ git branch -D <every branches but master>

1. Revert the changes made to foo.md and commit them
   
   $ git reset fd0dec5 foo.md

<!-- ## Submodules https://git-scm.com/book/en/v2/Git-Tools-Submodules

It often happens that while working on one project, you need to use another project from within it. Perhaps it’s a library that a third party developed or that you’re developing separately and using in multiple parent projects. A common issue arises in these scenarios: you want to be able to treat the two projects as separate yet still be able to use one from within the other.

-->

Documentation and links

• 1. RTFM
• man git
• man 7 gittutorial
• man 7 gitworkflows

On the www

• 1. Official
• Documentation
• Books
• Cheat Sheets: EN - FR

• 1. Good alternative documentation
• Roger Dudler
• Atlassian
• gitmagic

• 1. Courses
• GitHub
• CodeSchool
• Git Immersion

• 1. Documentation in French
• OpenClassRooms
• Polytechnique.fr
• gitmagic
• PutainDeCode
• Submodules vs Subtree

• 1. Facts
• Kernel SCM saga...
• Happiness is a warm SCM