<
From version < 37.1 >
edited by msp
on 2012/10/16 14:44
To version < 43.1 >
edited by msp
on 2012/10/16 16:41
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,15 +2,15 @@
2 2  
3 3  More in-depth Git documentation can be found on the [[official home page>>url:http://git-scm.com/documentation||shape="rect"]], which mentions books, videos, and links to other tutorials and references. Furthermore, the shell command {{code language="none"}}git help{{/code}} lists the most commonly used Git commands, and {{code language="none"}}git help <command>{{/code}} gives very detailed documentation for the specified Git command.
4 4  
5 -==== Contents ====
5 +=== Contents ===
6 6  
7 7  
8 8  
9 -{{toc style="circle" maxLevel="3"/}}
9 +{{toc style="circle" maxLevel="2"/}}
10 10  
11 11  = Creating Commits =
12 12  
13 -Most steps of this tutorial are done by typing shell commands. The grey boxes contain the commands you should enter, preceded by a {{code language="none"}}${{/code}} symbol, together with their output. While you may copy & paste these commands, some of them may require modifications to adapt them to your own projects.
13 +Most steps of this tutorial are done by typing shell commands. The grey boxes contain the commands you should enter, preceded by a {{code language="none"}}${{/code}} symbol, and followed by their output. While you may copy & paste these commands, some of them may require modifications to adapt them to your own projects. The output will be slightly different for many commands when you enter them, since it also depends on parameters such as the user name and time of execution.
14 14  
15 15  1. Read the [[Git for Computer Scientists>>url:http://eagain.net/articles/git-for-computer-scientists/||shape="rect"]] introduction (skip this if you are already familiar with Git).
16 16  1. For Linux, Git is available in its own package. Windows users can install [[msysGit>>url:http://msysgit.github.com/||shape="rect"]]. For Mac OSX, Git is available as part of [[Xcode>>url:https://developer.apple.com/xcode/||shape="rect"]]; if you cannot install that, use [[Git for OSX>>url:http://code.google.com/p/git-osx-installer/||shape="rect"]].
... ... @@ -132,7 +132,7 @@
132 132  
133 133  = Branching and Merging =
134 134  
135 -In the previous section you have created two commits on the default branch, which is named {{code language="none"}}master{{/code}}. Now you will create a new branch and commit there, thus adding complexity to the commit graph.
135 +In the previous section you have created two commits on the default branch, which is named {{code language="none"}}master{{/code}}. Now you will create a new branch and commit there, thus adding complexity to the commit graph. In general, you may create as many local branches as you like, since they are simple to use and can be a great tool to structure your work.
136 136  
137 137  1. (((
138 138  Create a branch with name //sketches//:
... ... @@ -205,7 +205,7 @@
205 205  {{/noformat}}
206 206  )))
207 207  1. (((
208 -Switch back to the {{code language="none"}}sketches{{/code}} branch and commit something there. Note that the {{code language="none"}}checkout{{/code}} command modifies your working copy, hence you have to update your text editor's content if you opened one of the files.
208 +Switch back to the {{code language="none"}}sketches{{/code}} branch and modify it as shown below. Note that the {{code language="none"}}checkout{{/code}} command modifies your working copy, hence you have to update your text editor's content if you opened one of the files.
209 209  
210 210  {{noformat}}
211 211  $ git checkout sketches
... ... @@ -221,7 +221,7 @@
221 221   1 files changed, 5 insertions(+), 0 deletions(-)
222 222  {{/noformat}}
223 223  
224 -Now our two branches have //diverged//, which means that they cannot be fast-forwarded anymore.
224 +Now your two branches have //diverged//, which means that they cannot be fast-forwarded anymore.
225 225  )))
226 226  1. (((
227 227  Merge the {{code language="none"}}master{{/code}} branch into {{code language="none"}}sketches{{/code}}:
... ... @@ -245,8 +245,8 @@
245 245   * The finite state machine has an initial state and one or more final states
246 246  {{/noformat}}
247 247  )))
248 -1. Commit the change to {{code language="none"}}notes.txt{{/code}}.
249 -1. Check out {{code language="none"}}sketches{{/code}} (make sure to refresh your text editor so {{code language="none"}}notes.txt{{/code}} is reset to its previous state, without the change made above).
248 +1. Commit the change o{{code language="none"}}notes.txt{{/code}}.
249 +1. Check out {{code language="none"}}sketches{{/code}} (make sure to refresh your text editor so that {{code language="none"}}notes.txt{{/code}} is reset to its previous state, without the change made above).
250 250  1. (((
251 251  Insert the following line after line 4 of {{code language="none"}}notes.txt{{/code}}:
252 252  
... ... @@ -254,7 +254,7 @@
254 254   * Each state transition can trigger head movement and data read/write
255 255  {{/noformat}}
256 256  )))
257 -1. Commit the change to {{code language="none"}}notes.txt{{/code}}.
257 +1. Commit the change of {{code language="none"}}notes.txt{{/code}}.
258 258  )))
259 259  1. (((
260 260  Merge the {{code language="none"}}master{{/code}} branch into the current branch ({{code language="none"}}sketches{{/code}}):
... ... @@ -334,6 +334,8 @@
334 334  
335 335  In the previous sections you have worked only with a local repository. The next step is to share this content with a remote repository. Later we will use [[Stash>>url:https://www.atlassian.com/software/stash/overview||shape="rect"]] for repository management, but we need to create group accounts for you first, thus you will use another system called [[Gitorious>>url:https://git.rtsys.informatik.uni-kiel.de/||shape="rect"]] for now.
336 336  
337 +Usually it is sufficient to have only one local copy of a Git repository. However, in this tutorial you will create a second copy in order to "simulate" what can happen if two users access the same remote repository: imagine the directories {{code language="none"}}turing{{/code}} and {{code language="none"}}turing2{{/code}} are each managed by a different user. You will simulate the resulting interference by switching your working directory between these two.
338 +
337 337  1. Register to the Gitorious system: [[https:~~/~~/git.rtsys.informatik.uni-kiel.de/>>url:https://git.rtsys.informatik.uni-kiel.de/||shape="rect"]] (use your //Institut für Informatik// login name and email address)
338 338  1. Go to your //Dashboard// → //Manage SSH keys// → //Add SSH key//
339 339  1. Copy & paste the content of your public SSH key.\\
... ... @@ -340,7 +340,8 @@
340 340  1*. If you don't have an SSH key: use the shell command {{code language="none"}}ssh-keygen{{/code}}, confirm the default destination file {{code language="none"}}~/.ssh/id_rsa{{/code}}, and choose whether to give a passphrase. If you have a passphrase, you need to enter it whenever you use your SSH key for the first time in a session. You can omit the passphrase, but that makes the key less secure. As result, the tool generates a private key {{code language="none"}}~/.ssh/id_rsa{{/code}}, which has to be kept secret, and a public key {{code language="none"}}~/.ssh/id_rsa.pub{{/code}}.
341 341  1. Go to //Projects// → //Create a new project// and call it "personal-<login>", replacing <login> with your own login name.
342 342  1. On the next page, create a repository named "turing" (or select //Add repository// on your project page).
343 -1. Once you are on the repository page, copy the URL shown in //Clone & push urls//.
345 +1. On the repository page, go to //Manage collaborators// → //Add collaborators// and add the user msp.
346 +1. Once you are back on the repository page, copy the URL shown in //Clone & push urls//.
344 344  1. Email the copied URL to [[msp@informatik.uni-kiel.de>>mailto:msp@informatik.uni-kiel.de||shape="rect"]]. This will serve as proof for your work on this tutorial.
345 345  1. (((
346 346  Transfer your {{code language="none"}}master{{/code}} branch to the new server-side repository. Replace the URL in the following command by the one copied from Gitorious:
... ... @@ -375,7 +375,7 @@
375 375  $ cd turing2
376 376  {{/noformat}}
377 377  
378 -The {{code language="none"}}clone{{/code}} command automatically creates a remote named {{code language="none"}}origin{{/code}} in the new local repository, which is set to the given URL.
381 +The {{code language="none"}}clone{{/code}} command automatically creates a remote named {{code language="none"}}origin{{/code}} in the new local repository, which is set to the given URL. You will use this second clone to simulate another user with access to the repository.
379 379  )))
380 380  1. Edit the file {{code language="none"}}examples.txt{{/code}} in the new clone ({{code language="none"}}turing2{{/code}}): replace {{code language="none"}}"a"{{/code}} in line 6 by {{code language="none"}}"c"{{/code}} and correct the tape representations in lines 9, 14, and 19 accordingly. Commit the change.
381 381  1. (((
... ... @@ -542,10 +542,10 @@
542 542   957f686..b58ded7 master -> master
543 543  {{/noformat}}
544 544  
545 -While {{code language="none"}}pull{{/code}} performs a {{code language="none"}}fetch{{/code}} and a {{code language="none"}}merge{{/code}}, {{code language="none"}}push{{/code}} transfers the new merged branch to the server. Note that during the merge operation conflicts can occur. In that case you have to resolve them and commit the changes before you can push.
548 +While {{code language="none"}}pull{{/code}} performs a {{code language="none"}}fetch{{/code}} and a {{code language="none"}}merge{{/code}}, {{code language="none"}}push{{/code}} transfers the new merged branch to the server. Note that during the merge operation conflicts can occur. In that case you have to resolve them and commit the changes before you can push. When used without parameters like shown above, {{code language="none"}}pull{{/code}} lookes in {{code language="none"}}.git/config{{/code}} to determine which branches to pull from which remotes.
546 546  )))
547 547  1. (((
548 -In order to check out the {{code language="none"}}sketches{{/code}} branch, which was previously pushed to the server, simply type the following command:
551 +In order to check out the {{code language="none"}}sketches{{/code}} branch locally, which was previously pushed to the server, simply type the following command:
549 549  
550 550  {{noformat}}
551 551  $ git checkout sketches
... ... @@ -553,7 +553,7 @@
553 553  Switched to a new branch 'sketches'
554 554  {{/noformat}}
555 555  
556 -This branch can be pushed and pulled with the server in the same way as you did for the {{code language="none"}}master{{/code}} branch.
559 +This branch can be pushed and pulled with the server in the same way as you did for the {{code language="none"}}master{{/code}} branch. Never check out {{code language="none"}}origin/sketches{{/code}}, since that is a remote tracking branch!
557 557  )))
558 558  
559 559  The {{code language="none"}}master{{/code}} branch should look like this:
... ... @@ -560,4 +560,116 @@
560 560  
561 561  [[image:attach:turing-graph-02.png]]
562 562  
563 -
566 += Other Useful Commands =
567 +
568 +This section contains optional steps that you don't need to push online, but can be useful for you to learn.
569 +
570 +=== Ignoring Files ===
571 +
572 +While working on his Machine, Alan Turing has produced a temporary file {{code language="none"}}experiments.tmp{{/code}}, which he does not want to commit in the repository:
573 +
574 +{{noformat}}
575 +$ git status
576 +# On branch master
577 +# Untracked files:
578 +# (use "git add <file>..." to include in what will be committed)
579 +#
580 +# experiments.tmp
581 +nothing added to commit but untracked files present (use "git add" to track)
582 +{{/noformat}}
583 +
584 +Since the extra mention of that file can make Git's status reports unnecessarily cluttered, Alan wants to ignore it permanently. Help him by adding a {{code language="none"}}.gitignore{{/code}} file to the repository:
585 +
586 +{{noformat}}
587 +$ echo "*.tmp" > .gitignore
588 +$ git add .gitignore
589 +$ git commit -m "added ignore file"
590 +[master 738ce4c] added ignore file
591 + 1 files changed, 1 insertions(+), 0 deletions(-)
592 + create mode 100644 .gitignore
593 +$ git status
594 +# On branch master
595 +# Your branch is ahead of 'origin/master' by 1 commit.
596 +#
597 +nothing to commit (working directory clean)
598 +{{/noformat}}
599 +
600 +Now the experiments.tmp{{code language="none"}}{{/code}} file is not considered when viewing the status. You can add arbitrary file name patterns to the {{code language="none"}}.gitignore{{/code}} file; for example it is a good idea to ignore {{code language="none"}}*.class{{/code}}, which are binary files generated for Java projects.
601 +
602 +=== Discarding Changes ===
603 +
604 +While working on his Machine, Alan Turing has made some changes to notes.txt that he later found out to be nonsense:
605 +
606 +{{noformat}}
607 +$ git status
608 +# On branch master
609 +# Changed but not updated:
610 +# (use "git add <file>..." to update what will be committed)
611 +# (use "git checkout -- <file>..." to discard changes in working directory)
612 +#
613 +# modified: notes.txt
614 +#
615 +no changes added to commit (use "git add" and/or "git commit -a")
616 +{{/noformat}}
617 +
618 +Help Alan by restoring the last committed state of that file:
619 +
620 +{{noformat}}
621 +$ git checkout HEAD notes.txt
622 +$ git status
623 +# On branch master
624 +nothing to commit (working directory clean)
625 +{{/noformat}}
626 +
627 +Instead of HEAD, which is the last commit on the current branch, you can also name any other branch or commit hash. In that case you would have to commit the change to make it permanent. While resolving conflicts it is possible to use {{code language="none"}}--theirs{{/code}} or {{code language="none"}}--ours{{/code}} instead of HEAD, which replaces the whole content of the respective file by their version (the one on the remote branch) or our version (the one on the current branch).
628 +
629 +A more brute-force option is using the {{code language="none"}}reset{{/code}} command:
630 +
631 +{{noformat}}
632 +$ git reset --hard
633 +HEAD is now at b58ded7 Merge branch 'master' of git.rtsys.informatik.uni-kiel.de:personal-msp/turing
634 +{{/noformat}}
635 +
636 +This resets //all// changes to the working copy to the head of the current branch, so use it with caution! However, {{code language="none"}}reset{{/code}} does not remove unstaged files. In order to do that in one command, use {{code language="none"}}clean{{/code}}:
637 +
638 +{{noformat}}
639 +$ git status
640 +# On branch master
641 +# Untracked files:
642 +# (use "git add <file>..." to include in what will be committed)
643 +#
644 +# test1.tmp
645 +# test2.tmp
646 +nothing added to commit but untracked files present (use "git add" to track)
647 +$ git clean -f
648 +Removing test1.tmp
649 +Removing test2.tmp
650 +{{/noformat}}
651 +
652 +=== Rebasing ===
653 +
654 +Consider the following situation:
655 +
656 +[[image:attach:turing-graph-03.png]]
657 +
658 +If you want to merge the changes made on the {{code language="none"}}master{{/code}} branch into the {{code language="none"}}sketches{{/code}} branch, the normal way is to use the {{code language="none"}}merge{{/code}} command and create a merge commit. However, the {{code language="none"}}rebase{{/code}} command gives an interesting alternative to that: it reapplies all commits done in the current branch starting from a given reference.
659 +
660 +{{noformat}}
661 +$ git rebase master
662 +First, rewinding head to replay your work on top of it...
663 +Applying: added another example
664 +Applying: state transitions
665 +Using index info to reconstruct a base tree...
666 +Falling back to patching base and 3-way merge...
667 +Auto-merging notes.txt
668 +{{/noformat}}
669 +
670 +Afterwards the commit graph looks like this:
671 +
672 +[[image:attach:turing-graph-04.png]]
673 +
674 +The two commits made in {{code language="none"}}sketches{{/code}} are reapplied starting from the head of the {{code language="none"}}master{{/code}} branch. The resulting structure of commits is much cleaner than before. It is even possible to squeeze multiple commits into one using {{code language="none"}}rebase{{/code}}. Note that in this example a merge conflict had to be resolved in the same way as it was done in Section "Branching and Merging"; instead of committing the resolved file, the rebase command is resumed with {{code language="none"}}git rebase --continue{{/code}}.
675 +
676 +{{warning}}
677 +Never rebase a branch that is already pushed online! Due to the structural change the rebased branch is no longer compatible with the previous one, and pushing it will fail, since fast-forward merge is not possible.
678 +{{/warning}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -2982157
1 +2982168
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/WS12EclPract/pages/2982157/Git
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/WS12EclPract/pages/2982168/Git