<
From version < 29.1 >
edited by msp
on 2012/10/15 15:42
To version < 36.1 >
edited by msp
on 2012/10/16 14:34
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,11 +1,17 @@
1 1  This tutorial will address the source code management (SCM) tool named [[Git>>url:http://git-scm.com/||shape="rect"]]. By following these steps you should learn about the basic usage of Git, which is required for the whole practical course. Furthermore, Git is a great SCM tool, and it's good to know how to use it. During this tutorial, we will follow Alan Turing's thoughts towards developing the [[Turing Machine>>url:http://en.wikipedia.org/wiki/Turing_machine||shape="rect"]].
2 2  
3 -More in-depth 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.
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 ====
6 +
7 +
8 +
9 +{{toc style="circle" maxLevel="3"/}}
10 +
5 5  = Creating Commits =
6 6  
7 7  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).
8 -1. For Linux, Git is available in its own package. Windows users can install [[msysGit>>url:http://msysgit.github.com/||shape="rect"]]. For MacOS, 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"]].
14 +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"]].
9 9  1. (((
10 10  Configure your name and email address (will be included in all commits you create):
11 11  
... ... @@ -24,7 +24,7 @@
24 24  Initialized empty Git repository in ~/turing/.git/
25 25  {{/noformat}}
26 26  
27 -The {{code language="none"}}.git{{/code}} subdirectory contains all history and metadata of the repository. You should not modify it.
33 +The {{code language="none"}}.git{{/code}} subdirectory contains all history and metadata of the repository. You should not modify it. The {{code language="none"}}turing{{/code}} directory contains the //working copy//, that is the currently checked-out snapshot. You work by modifying your working copy and committing the modifications to the repository (contained in {{code language="none"}}.git{{/code}}).
28 28  )))
29 29  1. (((
30 30  Add and commit some content: copy [[attach:notes.txt]]{{code language="none"}}{{/code}} to your {{code language="none"}}turing{{/code}} directory.
... ... @@ -158,7 +158,7 @@
158 158  It is also possible to create a branch and switch immediately to it using the option {{code language="none"}}-b{{/code}} of {{code language="none"}}git checkout{{/code}}.
159 159  )))
160 160  1. (((
161 -Add the new file [[attach:examples.txt]]:
167 +Download and add the new file [[attach:examples.txt]]{{code language="none"}}{{/code}}:
162 162  
163 163  {{noformat}}
164 164  $ git add examples.txt
... ... @@ -167,4 +167,389 @@
167 167   1 files changed, 20 insertions(+), 0 deletions(-)
168 168   create mode 100644 examples.txt
169 169  {{/noformat}}
176 +
177 +Inspecting the commit graph with {{code language="none"}}gitk{{/code}} (or another graphical viewer) you see that the {{code language="none"}}sketches{{/code}} branch now has three commits, while {{code language="none"}}master{{/code}} is still at the second commit.
170 170  )))
179 +1. (((
180 +Merging the {{code language="none"}}sketches{{/code}} branch into {{code language="none"}}master{{/code}} means that all changes that have been made in {{code language="none"}}sketches{{/code}} are also applied to {{code language="none"}}master{{/code}}. In order to perform this merge, we have to check out the {{code language="none"}}master{{/code}} branch first:
181 +
182 +{{noformat}}
183 +$ git checkout master
184 +Switched to branch 'master'
185 +$ git merge sketches
186 +Updating 52e2d49..cd63135
187 +Fast-forward
188 + examples.txt | 20 ++++++++++++++++++++
189 + 1 files changed, 20 insertions(+), 0 deletions(-)
190 + create mode 100644 examples.txt
191 +{{/noformat}}
192 +
193 +This was a //fast-forward// merge: since the {{code language="none"}}master{{/code}} branch was completely contained in the {{code language="none"}}sketches{{/code}} branch, the merge could be done by simply changing the head pointer of {{code language="none"}}master{{/code}} to be the same as the head of {{code language="none"}}sketches{{/code}}.
194 +)))
195 +1. (((
196 +Now add the line "{{code language="none"}}see some examples in 'examples.txt'{{/code}}" to the file {{code language="none"}}notes.txt{{/code}} and commit this change in the current branch:
197 +
198 +{{noformat}}
199 +$ git add notes.txt
200 +$ git commit -m "added reference to the new examples"
201 +[master a5e244f] added reference to the new examples
202 + 1 files changed, 2 insertions(+), 1 deletions(-)
203 +{{/noformat}}
204 +)))
205 +1. (((
206 +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.
207 +
208 +{{noformat}}
209 +$ git checkout sketches
210 +Switched to branch 'sketches'
211 +{{/noformat}}
212 +
213 +Add the line "{{code language="none"}}Move one step left:{{/code}}" and write an updated version of the tape with tape head in the file {{code language="none"}}examples.txt{{/code}}, then commit.
214 +
215 +{{noformat}}
216 +$ git add examples.txt
217 +$ git commit -m "added another example"
218 +[sketches 55a9cb1] added another example
219 + 1 files changed, 5 insertions(+), 0 deletions(-)
220 +{{/noformat}}
221 +
222 +Now our two branches have //diverged//, which means that they cannot be fast-forwarded anymore.
223 +)))
224 +1. (((
225 +Merge the {{code language="none"}}master{{/code}} branch into {{code language="none"}}sketches{{/code}}:
226 +
227 +{{noformat}}
228 +$ git merge master
229 +Merge made by recursive.
230 + notes.txt | 3 ++-
231 + 1 files changed, 2 insertions(+), 1 deletions(-)
232 +{{/noformat}}
233 +
234 +Using {{code language="none"}}gitk{{/code}} you can see that a new commit was created that has two parent commits. Such a commit is called //merge// commit and is done automatically when a non-fast-forward merge is applied.
235 +)))
236 +1. (((
237 +Add a commit in each of the two branches using the commands you have already learned.
238 +1. Check out {{code language="none"}}master{{/code}}.
239 +1. (((
240 +Insert the following line after line 4 of {{code language="none"}}notes.txt{{/code}}:
241 +
242 +{{noformat nopanel="true"}}
243 + * The finite state machine has an initial state and one or more final states
244 +{{/noformat}}
245 +)))
246 +1. Commit the change to {{code language="none"}}notes.txt{{/code}}.
247 +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. (((
249 +Insert the following line after line 4 of {{code language="none"}}notes.txt{{/code}}:
250 +
251 +{{noformat nopanel="true"}}
252 + * Each state transition can trigger head movement and data read/write
253 +{{/noformat}}
254 +)))
255 +1. Commit the change to {{code language="none"}}notes.txt{{/code}}.
256 +)))
257 +1. (((
258 +Merge the {{code language="none"}}master{{/code}} branch into the current branch ({{code language="none"}}sketches{{/code}}):
259 +
260 +{{noformat}}
261 +$ git merge master
262 +Auto-merging notes.txt
263 +CONFLICT (content): Merge conflict in notes.txt
264 +Automatic merge failed; fix conflicts and then commit the result.
265 +{{/noformat}}
266 +
267 +As expected, the branches could not be merged automatically, since both branches modified the same line in the same file.
268 +)))
269 +1. (((
270 +Use the {{code language="none"}}status{{/code}} command to see the list of affected files:
271 +
272 +{{noformat}}
273 +$ git status
274 +# On branch sketches
275 +# Unmerged paths:
276 +# (use "git add/rm <file>..." as appropriate to mark resolution)
277 +#
278 +# both modified: notes.txt
279 +#
280 +no changes added to commit (use "git add" and/or "git commit -a")
281 +{{/noformat}}
282 +)))
283 +1. (((
284 +The modified {{code language="none"}}notes.txt{{/code}} should now contain the following text:
285 +
286 +{{noformat nopanel="true"}}
287 +<<<<<<< HEAD
288 + * Each state transition can trigger head movement and data read/write
289 +=======
290 + * The finite state machine has an initial state and one or more final states
291 +>>>>>>> master
292 +{{/noformat}}
293 +
294 +The upper line is the one committed to {{code language="none"}}sketches{{/code}}, while the lower line was committed to {{code language="none"}}master{{/code}}. You have to resolve the conflict by editing the file. In this case the conflict is resolved by keeping both lines in arbitrary order, that means you should just remove the conflict markers (lines 5, 7, and 9 in {{code language="none"}}notes.txt{{/code}}).
295 +)))
296 +1. (((
297 +Use the {{code language="none"}}add{{/code}} command to mark {{code language="none"}}notes.txt{{/code}} as resolved. Entering {{code language="none"}}git commit{{/code}} without a message will open a text editor with an automatically created commit message. Just close the editor, and the merge commit is completed:
298 +
299 +{{noformat}}
300 +$ git commit
301 +[sketches 21d5ddb] Merge branch 'master' into sketches
302 +$ git show 21d5ddb
303 +commit 21d5ddbbcba4e36464653a2a550dbf595ead921f
304 +Merge: 17f75c7 8af2d50
305 +Author: Miro Spoenemann <msp@informatik.uni-kiel.de>
306 +Date: Tue Oct 16 10:44:09 2012 +0200
307 +
308 + Merge branch 'master' into sketches
309 +
310 + Conflicts:
311 + notes.txt
312 +
313 +diff --cc notes.txt
314 +index 8f72873,bb81298..ba94a08
315 +--- a/notes.txt
316 ++++ b/notes.txt
317 +@@@ -2,6 -2,6 +2,7 @@@
318 + * Tape head can read or write data
319 + * Tape head can move left or right
320 + * The head is controlled by a finite state machine
321 + + * Each state transition can trigger head movement and data read/write
322 ++ * The finite state machine has an initial state and one or more final states
323 + see some examples in 'examples.txt'
324 +{{/noformat}}
325 +)))
326 +
327 +The {{code language="none"}}gitk{{/code}} tool should now display this graph:
328 +
329 +[[image:attach:turing-graph-01.png]]
330 +
331 += Remote Repositories =
332 +
333 +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.
334 +
335 +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)
336 +1. Go to your //Dashboard// → //Manage SSH keys// → //Add SSH key//
337 +1. Copy & paste the content of your public SSH key.\\
338 +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}}.
339 +1. Go to //Projects// → //Create a new project// and call it "personal-<login>", replacing <login> with your own login name.
340 +1. On the next page, create a repository named "turing" (or select //Add repository// on your project page).
341 +1. Once you are on the repository page, copy the URL shown in //Clone & push urls//.
342 +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.
343 +1. (((
344 +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:
345 +
346 +{{noformat}}
347 +$ git remote add gitorious git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
348 +$ git push gitorious master
349 +Counting objects: 15, done.
350 +Delta compression using up to 16 threads.
351 +Compressing objects: 100% (13/13), done.
352 +Writing objects: 100% (15/15), 1.54 KiB, done.
353 +Total 15 (delta 3), reused 0 (delta 0)
354 +remote: => Syncing Gitorious... [OK]
355 +To git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
356 + * [new branch] master -> master
357 +{{/noformat}}
358 +
359 +The first command adds a //remote// named "gitorious" to your local repository, which is just a bookmark for the long URL. The second command transfers the {{code language="none"}}master{{/code}} branch to the server, which is called //pushing//. After that is done, reload the Gitorious page in your browser, and you see all changes that are transferred to the server-side repository.
360 +)))
361 +1. (((
362 +Create a local clone of your remote repository (replace the URL accordingly):
363 +
364 +{{noformat}}
365 +$ cd ..
366 +$ git clone git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git turing2
367 +Initialized empty Git repository in /home/msp/tmp/turing2/.git/
368 +remote: Counting objects: 15, done.
369 +remote: Compressing objects: 100% (13/13), done.
370 +remote: Total 15 (delta 3), reused 0 (delta 0)
371 +Receiving objects: 100% (15/15), done.
372 +Resolving deltas: 100% (3/3), done.
373 +$ cd turing2
374 +{{/noformat}}
375 +
376 +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.
377 +)))
378 +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.
379 +1. (((
380 +Push the new commit to the server:
381 +
382 +{{noformat}}
383 +$ git push
384 +Counting objects: 5, done.
385 +Delta compression using up to 16 threads.
386 +Compressing objects: 100% (3/3), done.
387 +Writing objects: 100% (3/3), 362 bytes, done.
388 +Total 3 (delta 1), reused 0 (delta 0)
389 +remote: => Syncing Gitorious... [OK]
390 +To git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
391 + 8af2d50..1d1577f master -> master
392 +{{/noformat}}
393 +
394 +In this case the push command can be used without arguments, which means that it pushes all branches as configured in {{code language="none"}}.git/config{{/code}}:
395 +
396 +{{noformat}}
397 +$ more .git/config
398 +[core]
399 + repositoryformatversion = 0
400 + filemode = true
401 + bare = false
402 + logallrefupdates = true
403 +[remote "origin"]
404 + fetch = +refs/heads/*:refs/remotes/origin/*
405 + url = git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
406 +[branch "master"]
407 + remote = origin
408 + merge = refs/heads/master
409 +{{/noformat}}
410 +
411 +Here the branch {{code language="none"}}master{{/code}} is linked with the remote {{code language="none"}}origin{{/code}}, hence {{code language="none"}}git push{{/code}} does the same as {{code language="none"}}git push origin master{{/code}}.
412 +)))
413 +1. (((
414 +Go back to the original local repository and check out the {{code language="none"}}master{{/code}} branch:
415 +
416 +{{noformat}}
417 +$ cd ../turing
418 +$ git checkout master
419 +Switched to branch 'master'
420 +{{/noformat}}
421 +)))
422 +1. (((
423 +Merge the {{code language="none"}}sketches{{/code}} branch into {{code language="none"}}master{{/code}}:
424 +
425 +{{noformat}}
426 +$ git merge sketches
427 +Updating 8af2d50..21d5ddb
428 +Fast-forward
429 + examples.txt | 5 +++++
430 + notes.txt | 1 +
431 + 2 files changed, 6 insertions(+), 0 deletions(-)
432 +{{/noformat}}
433 +
434 +Now your local {{code language="none"}}master{{/code}} branch and the one on the server-side repository have diverged
435 +)))
436 +1. (((
437 +Fetch the server-side changes:
438 +
439 +{{noformat}}
440 +$ git fetch gitorious
441 +remote: Counting objects: 5, done.
442 +remote: Compressing objects: 100% (3/3), done.
443 +remote: Total 3 (delta 1), reused 0 (delta 0)
444 +Unpacking objects: 100% (3/3), done.
445 +From git.rtsys.informatik.uni-kiel.de:personal-msp/turing
446 + 8af2d50..1d1577f master -> gitorious/master
447 +{{/noformat}}
448 +
449 +Now the change to {{code language="none"}}examples.txt{{/code}} that was previously committed in the {{code language="none"}}turing2{{/code}} repository is stored in a //remote tracking branch// named {{code language="none"}}gitorious/master{{/code}}:
450 +
451 +{{noformat}}
452 +$ git branch -a
453 +* master
454 + sketches
455 + remotes/gitorious/master
456 +{{/noformat}}
457 +
458 +You can analyze the remote tracking branch using the {{code language="none"}}log{{/code}} and {{code language="none"}}show{{/code}} commands. However, you should never directly modify a remote tracking branch.
459 +)))
460 +1. (((
461 +You can merge the remote changes into your local {{code language="none"}}master{{/code}} branch with the following command:
462 +
463 +{{noformat}}
464 +$ git merge gitorious/master
465 +Auto-merging examples.txt
466 +Merge made by recursive.
467 + examples.txt | 8 ++++----
468 + 1 files changed, 4 insertions(+), 4 deletions(-)
469 +{{/noformat}}
470 +
471 +Since this combination of {{code language="none"}}fetch{{/code}} and {{code language="none"}}merge{{/code}} is used very often, Git offers a shortcut for it, namely the {{code language="none"}}pull{{/code}} command. In this case the according command would have been {{code language="none"}}git pull gitorious master{{/code}}.
472 +)))
473 +1. (((
474 +Push the merged branch to the server, and then push the {{code language="none"}}sketches{{/code}} branch, which is not on the server yet:
475 +
476 +{{noformat}}
477 +$ git push gitorious master
478 +Counting objects: 23, done.
479 +Delta compression using up to 16 threads.
480 +Compressing objects: 100% (14/14), done.
481 +Writing objects: 100% (14/14), 1.65 KiB, done.
482 +Total 14 (delta 4), reused 0 (delta 0)
483 +remote: => Syncing Gitorious... [OK]
484 +To git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
485 + 1d1577f..957f686 master -> master
486 +$ git push gitorious sketches
487 +Total 0 (delta 0), reused 0 (delta 0)
488 +remote: => Syncing Gitorious... [OK]
489 +To git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
490 + * [new branch] sketches -> sketches
491 +{{/noformat}}
492 +)))
493 +1. (((
494 +As next step change your working directory to the second local repository {{code language="none"}}turing2{{/code}}, add the following line to the end of {{code language="none"}}notes.txt{{/code}} in the {{code language="none"}}turing2{{/code}} directory, and commit the change:
495 +
496 +{{noformat nopanel="true"}}
497 +TODO: formal definition
498 +{{/noformat}}
499 +)))
500 +1. (((
501 +Trying to push this commit to the server results in the following error message:
502 +
503 +{{noformat}}
504 +$ git push
505 +To git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
506 + ! [rejected] master -> master (non-fast-forward)
507 +error: failed to push some refs to 'git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git'
508 +To prevent you from losing history, non-fast-forward updates were rejected
509 +Merge the remote changes before pushing again. See the 'Note about
510 +fast-forwards' section of 'git push --help' for details.
511 +{{/noformat}}
512 +
513 +This is because you have modified the branch while working in the original {{code language="none"}}turing{{/code}} repository, and these changes have to be merged with the new commit you have just made for {{code language="none"}}notes.txt{{/code}}.
514 +)))
515 +1. (((
516 +The solution is to apply the {{code language="none"}}pull{{/code}} command followed by the {{code language="none"}}push{{/code}} command:
517 +
518 +{{noformat}}
519 +$ git pull
520 +remote: Counting objects: 23, done.
521 +remote: Compressing objects: 100% (14/14), done.
522 +remote: Total 14 (delta 4), reused 0 (delta 0)
523 +Unpacking objects: 100% (14/14), done.
524 +From git.rtsys.informatik.uni-kiel.de:personal-msp/turing
525 + 1d1577f..957f686 master -> origin/master
526 + * [new branch] sketches -> origin/sketches
527 +Auto-merging notes.txt
528 +Merge made by recursive.
529 + examples.txt | 5 +++++
530 + notes.txt | 1 +
531 + 2 files changed, 6 insertions(+), 0 deletions(-)
532 +$ git push
533 +Counting objects: 10, done.
534 +Delta compression using up to 16 threads.
535 +Compressing objects: 100% (6/6), done.
536 +Writing objects: 100% (6/6), 673 bytes, done.
537 +Total 6 (delta 2), reused 0 (delta 0)
538 +remote: => Syncing Gitorious... [OK]
539 +To git@git.rtsys.informatik.uni-kiel.de:personal-msp/turing.git
540 + 957f686..b58ded7 master -> master
541 +{{/noformat}}
542 +
543 +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.
544 +)))
545 +1. (((
546 +In order to check out the {{code language="none"}}sketches{{/code}} branch, which was previously pushed to the server, simply type the following command:
547 +
548 +{{noformat}}
549 +$ git checkout sketches
550 +Branch sketches set up to track remote branch sketches from origin.
551 +Switched to a new branch 'sketches'
552 +{{/noformat}}
553 +
554 +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.
555 +)))
556 +
557 +The {{code language="none"}}master{{/code}} branch should look like this:
558 +
559 +[[image:attach:turing-graph-02.png]]
560 +
561 +
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -2982132
1 +2982155
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/WS12EclPract/pages/2982132/Git
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/WS12EclPract/pages/2982155/Git