]> rtime.felk.cvut.cz Git - edu/osp-wiki.git/blobdiff - cviceni/4.mdwn
(no commit message)
[edu/osp-wiki.git] / cviceni / 4.mdwn
index 191daaa1783c5b0ab3ebd54c3d37dc98d689d204..04288fa84f37d7c3db43f0bc37f78c1da7cbd79b 100644 (file)
@@ -12,25 +12,26 @@ Konkrétně nás bude zajímat:
 * využití Gitu pro distribuovaný vývojový model, který je praktikován
   mnoha open source projekty,
 * efektivní prohledávání historie projektu, které je užitečné
-  například při rozhodování, jak správně vyřešit určitý konflikt.
+  například při rozhodování, jak správně vyřešit určitý konflikt a
+* řešení konfliktů.
 
 [git]:http://git-scm.com/
 
 Úvod
 ====
 
-Git je velmi univerzální nástroj pro správu a synchronizaci dat
-v souborech. Kromě verzování softwaru ho lidé používají
-k [mnoha dalším činnostem][gitsurvey-usedfor]. Jedna z často
-zmiňovaných nevýhod Gitu je, že oproti jiným verzovacím systémům je
-těžší se ho naučit a používat. Možným důvodem je to, že git nabízí
-větší funkcionalitu než většina ostatních systémů, která se ale
-využije jen ve speciálních případech – například jen u extrémně
+Git je poměrně univerzální nástroj pro správu a synchronizaci dat
+v souborech. Kromě verzování softwaru ho lidé používají k mnoha dalším
+činnostem (viz [Git User's Survey 2012, otázka 8][gitsurvey]). Jedna
+z často zmiňovaných nevýhod Gitu je, že oproti jiným verzovacím
+systémům je těžší se ho naučit a používat. Možným důvodem je to, že
+git nabízí větší funkcionalitu než většina ostatních systémů, která se
+ale využije jen ve speciálních případech – například jen u extrémně
 velkých projektů jako Linuxové jádro. Ať už to tak je, nebo ne, faktem
 je, že Git se neustále vyvíjí a mnoho úsilí je věnováno právě zlepšení
 uživatelské přivětivosti.
 
-[gitsurvey-usedfor]:http://www.survs.com/app/7/wo/GffJpx48NlVaG9rZZGKsI0/0.0.0.7.7.3.3.1.1.5.1.1.1.9.1
+[gitsurvey]:https://www.survs.com/results/QPESOB10/ME8UTHXM4M
 
 Pro pochopení Gitu je důležité mít základní představu o tom, jak Git
 pracuje s větvemi, což bylo popsáno v [[přednášce|prednasky/intro-to-git.pdf]]
@@ -48,7 +49,8 @@ pomocí grafických nástrojů:
 
 * Příkaz `git gui` je grafický nástroj částečně nahrazující příkazy
   `git status` a `git commit`. Pomocí menu je možné provádět i další
-  operace jako např. vytváření větví a práce se vzdálenými repozitáři.
+  operace jako např. vytváření větví nebo pracovat se vzdálenými
+  repozitáři.
 
 * Dále existuje ještě spousta dalších [nástrojů][tools]. Já osobně používám
   kromě výše zmíněných příkazů ještě `tig` a `qgit`.
@@ -87,54 +89,33 @@ Lokální větve
    Dostaneme něco jako:
    
        # On branch master
-          # Changed but not updated:
-          #   (use "git add <file>..." to update what will be committed)
-          #   (use "git checkout -- <file>..." to discard changes in working directory)
-          #
-          #    modified:       po/az.po
-          #    modified:       po/be-tarask.po
-          #    modified:       po/be.po
-          #       ...
-          #    modified:       src/cmddef.h
-          #    modified:       src/main.c
-   Vidíme, že pracujeme na větvi *master* a vzhledem k verzi uložené v
-   repozitáři máme několik změněných souborů.
+       # Changes not staged for commit:
+       #   (use "git add <file>..." to update what will be committed)
+       #   (use "git checkout -- <file>..." to discard changes in working directory)
+       #
+       #       modified:   lib/keybind.h
+       #       modified:   src/filemanager/midnight.c
+       #
+       # Untracked files:
+       #   (use "git add <file>..." to include in what will be committed)
+       #
+       #       misc/ext.d/doc.sh
+       #    ...
+       no changes added to commit (use "git add" and/or "git commit -a")
+
+   Vidíme, že pracujeme na větvi *master* a vzhledem k verzi uložené
+   v repozitáři máme několik změněných souborů.
 
 [mc]:http://www.midnight-commander.org/
 
-1. Midnight commander má bohužel jednu vlastnost, která může ztížit
-   vaše začátky s gitem. Při kompilaci dojde k automatickému
-   přegenerování některých souborů v repozitáři a git potom hlásí, že
-   jsme tyto soubory změnili a "otravuje" s nimi při každém commitu.
-   
-   Naštěstí existuje možnost jak gitu říct, že nás změny v některých
-   souborech nezajímají: 
-   
-       git update-index --assume-unchanged $(git ls-files po m4)
-
-   Příkaz `git ls-files po m4` vypíše všechny soubory z adresářů *po*
-   a *m4*, které jsou spravované gitem a příkazem `git update-index
-   --assume-unchanged` pak gitu sdělíme, aby si do indexu poznamenal,
-   že má tyto soubory ignorovat.
-   
-   > *Poznámka:* Možná víte o souborech *.gitignore* (viz `man
-   > gitignore`), které slouží k podobnému účelu. Ostatně midnight
-   > commander je také využívá, jak se můžete snadno přesvědčit:
-   >
-   >     cat .gitignore
-   >
-   > Soubory *.gitignore* se ale vztahují pouze na soubory, které
-   > ještě nejsou součástí repozitáře, což není případ výše zmíněných
-   > souborů.
-
 3. Vytvoříme větev *cviceni1* a přepneme se na ni:
 
        git checkout -b cviceni1
 
    Nyní už by měl `git status` ukazovat že pracujeme s větví
-   *cviceni1* a vidíme pouze námi modifikované soubory.
+   *cviceni1*.
 
-4. Nyní provedeme *commit*:
+4. Provedeme *commit*, t.j. uložíme všechny naše změny do lokálního repozitáře:
 
        git commit -a -m 'Zmeny z prvniho cviceni'
        
@@ -143,9 +124,9 @@ Lokální větve
    editor a nechá nás napsat zprávu v něm.   
 
    > *Poznámka:* Pokud vám nevyhovuje výchozí editor (většinou `vi`),
-   > nastavte si, že chcete používat jiný editor (např. `pico`):
+   > nastavte si, že chcete používat jiný editor (např. `nano`):
    > 
-   >     git config --global core.editor pico
+   >     git config --global core.editor nano
 
 5. Nyní se přepneme zpět na větev *master*:
 
@@ -160,7 +141,7 @@ Lokální větve
 Práce s více vzdálenými repozitáři
 ----------------------------------
 
-Do teď jsme pracovali pouze s jedním vzdáleným repozitářem. Mezi velké
+Doposud jsme pracovali pouze s jedním vzdáleným repozitářem. Mezi velké
 výhody gitu (a ostatních distribuovaných verzovacích systémů) patří
 schopnost pracovat s více vzdálenými repozitáři.
 
@@ -178,7 +159,7 @@ schopnost pracovat s více vzdálenými repozitáři.
        git remote add osp ssh://git@rtime.felk.cvut.cz/osp/mc
 
    V tomto repozitáři je uloženo zadání dnešní úlohy. Abyste se k němu
-   dostali, musí server znát váš veřenjný SSH klíč. Jak toho docílit
+   dostali, musí server znát váš veřejný SSH klíč. Jak toho docílit
    najdete na [[samostatné stránce|rtime-git-ssh-key]]. Přístup k
    repozitářům na serveru rtime budete potřebovat i v písemce. **Proto
    vám důrazně doporučujeme zprovoznit přístup už na tomto cvičení,
@@ -189,20 +170,22 @@ schopnost pracovat s více vzdálenými repozitáři.
        git fetch osp
    V případě úspěchu bude výstup vypadat následovně:
 
-       remote: Counting objects: 17, done.
-          remote: Compressing objects: 100% (9/9), done.
-          remote: Total 10 (delta 4), reused 7 (delta 1)
-          Unpacking objects: 100% (10/10), done.
-          From ssh://rtime.felk.cvut.cz/osp/mc
-               * [new branch]          master     -> osp/master
-               * [new branch]          only-directories -> osp/only-directories
+       remote: Counting objects: 34, done.
+       remote: Compressing objects: 100% (17/17), done.
+       remote: Total 20 (delta 17), reused 6 (delta 3)
+       Unpacking objects: 100% (20/20), done.
+       From ssh://rtime.felk.cvut.cz/osp/mc
+        * [new branch]      master     -> osp/master
+        * [new branch]      only-directories -> osp/only-directories
+        * [new branch]      only-directories-old -> osp/only-directories-old
 
-3. Příkaz nám vypíše, že v repozitáři byly dvě nové větve. Všechny
+3. Příkaz nám vypíše, že v repozitáři byly tři nové větve. Všechny
    větve ze vzdálených repozitářů vypíšeme příkazem
    
        git branch -r
    Zjednodušeně řečeno, jediný rozdíl mezi lokální a vzdálenou větví
-   je v tom, že jméno vzdálené věteve má prefix `<remote>/`.
+   je v tom, že jméno vzdálené větve má prefix `<remote>/` (v našem
+   případě `origin/` nebo `osp/`).
 
 4. Nyní nás zajímá co je ve větvích, které jsme právě stáhli:
 
@@ -211,10 +194,22 @@ schopnost pracovat s více vzdálenými repozitáři.
    Tyto dva příkazy jsou ekvivalentní a vypisují commity, které jsou
    ve větvi *osp/only-directories* a zároveň nejsou (^) ve větvi *master*.
    
-   Chcete-li vidět i změny v kódu použijte jeden z následujících příkazů:
+   Chcete-li vidět i změny v kódu (patch) použijte jeden
+   z následujících příkazů:
 
        git log -p osp/only-directories ^master
-          gitk osp/only-directories ^master
+       gitk osp/only-directories ^master
+
+   Výše uvedené příkazy zobrazují změny provedené jednotlivými
+   commity. Pokud nás zajímá celková změna bez rozdělení na jednotlivé
+   committy, pomůže nám příkaz `git diff`:
+
+       git diff master..osp/only-directories
+       git diff master osp/only-directories
+
+   První příkaz zobrazí změny, které obsahuje verze *only-directories* a
+   nejsou ve větvi master. Druhý příkaz zobrazí kompletní rozdíl, tj.
+   i změny, které jsou ve větvi *master* a ne v *only-directories*.
 
 6. Podobně můžeme postupovat i s původním repozitářem. Jméno *origin*
    je výchozí a proto ho nemusíme zadávat:
@@ -228,7 +223,7 @@ Slučování větví (merge)
 -----------------------
 
 Operace slučující dvě a více větví do jedné se nazývá *merge*. V Gitu
-Můžou při slučování nastat tři situace:
+můžou při slučování nastat tři situace:
 
 * *Already up-to-date* je situace, kdy už je větev, kterou chceme
   sloučit, dosažitelná z aktuální větve (už byla sloučena v
@@ -243,7 +238,7 @@ Můžou při slučování nastat tři situace:
 Pokud došlo v případě *True merge* ke změně stejného místa v kódu v
 obou větvích, dojde k tzv. *konfliktu*, který musí být vyřešen ručně.
 
-1. Zkuste provést sloučení vaší větve *master* s *origin/master*
+1. Zkuste provést sloučení své větve *master* s *origin/master*
 
        git merge origin/master
    Výsledkem bude *Fast forward* a uvidíme jaké soubory byly změněny:
@@ -254,7 +249,7 @@ obou větvích, dojde k tzv. *konfliktu*, který musí být vyřešen ručně.
         configure.ac                  |    1 +
         contrib/Makefile.am           |    9 +-
         ...
-   Toto je velmi častá operace a proto lze oprace `fetch` a `merge`
+   Toto je velmi častá operace a proto lze operace `fetch` a `merge`
    nahradit jedním příkazem
 
        git pull
@@ -286,112 +281,106 @@ Konflikt lze řešit několika způsoby (viz také `git merge --help`):
 
 * Vzdáme to a vrátíme se k verzi před slučováním
 
-       git reset --hard
+       git merge --abort
        
 * Konflikt vyřešíme a oznámíme to gitu příkazy `git add` a `git
   commit` (jak nám git napovídá v hláškách)
 
 V průběhu řešení konfliktu je užitečné používat příkaz `git status`,
-Abychom zjistili co je ještě potřeba vyřešit. V našem případě vypadá
-Výstup zhruba takhle:
+abychom zjistili, co je ještě potřeba vyřešit. V našem případě vypadá
+výstup zhruba takto:
+   
+    On branch homework
+    You have unmerged paths.
+      (fix conflicts and run "git commit")
+   
+    Changes to be committed:
+   
+       modified:   doc/man/mc.1.in
+   
+    Unmerged paths:
+      (use "git add <file>..." to mark resolution)
    
-    # On branch homework
-    # Changes to be committed:
-    #
-    #  modified:   doc/man/mc.1.in
-    #
-    # Unmerged paths:
-    #   (use "git add/rm <file>..." as appropriate to mark resolution)
-    #
-    #  both modified:      src/filemanager/find.c
+       both modified:   src/filemanager/find.c
 
 Konflikt lze řešit následujícími způsoby:
 
-* V textovém editoru najdeme sekvence `<<<<<<<<`, `=========` a
-  `>>>>>>>>`, kterými jsou označené jednotlivé konfliktní oblasti.
-  Tato místa musíme opravit tak, aby dávala smysl a poté zmíněné
-  sekvence znaků smažeme.
-* `git mergetool` je nástroj, který spouští grafický nástroj (např.
-  [kdiff3][kdiff3]), který vám se slučováním pomůže. 
+* Soubor s konfliktem otevřeme v textovém editoru a najdeme sekvence
+  `<<<<<<<<`, `=========` a `>>>>>>>>`, kterými jsou označené
+  jednotlivé konfliktní oblasti. Tato místa musíme opravit tak, aby
+  kód dával smysl a poté zmíněné sekvence znaků smažeme.
+* Použijeme příkaz `git mergetool`, který spouští grafický nástroj
+  (např. [kdiff3][kdiff3] nebo `meld`), který nám se slučováním
+  pomůže.
   
-  `kdiff3` vedle
-  sebe zobrazuje 3 různé verze projektu: poslední společná verze
-  (base), verzi z větve před slučováním (local) a verzi ze slučované
-  větve (remote) tj. té uvedené jako parametr v příkazu `git merge`.
+  `kdiff3` vedle sebe zobrazuje 3 různé verze projektu: poslední
+  společnou verzi (base), verzi z větve před slučováním (local) a
+  verzi ze slučované větve (remote), tj. té uvedené jako parametr
+  v příkazu `git merge`.
   
   Ve spodní části obrazovky je pak vidět výsledek slučování, který
   můžeme měnit buď přímou editací a nebo výběrem jednotlivých verzí
   pomocí tlačítek A, B a C. V tomto okně je potřeba zbavit se všech
-  řadek, které maji v levém sloupci `?` - tj. konfliktů.
-* `gitk --merge` - zobrazí pouze commity, které modifikovaly
-  konfliktní soubory.
+  řádek, které mají v levém sloupci `?` – tj. konfliktů.
 
-[kdiff3]:http://kdiff3.sourceforge.net/
+Při řešení konfliktů nám může pomoct i příkaz `gitk --merge`, který
+zobrazí pouze commity, které modifikovaly konfliktní soubory.
+Jednoduše tam můžeme zjistit, které změny konflikt způsobily.
 
-Repozitář na repo.or.cz
----------------------------
+Git obsahuje poměrně jednoduchý algoritmus (v porovnání s jinými
+verzovacími systémy) pro slučování různých verzí souborů. Některým
+studentům se to nelíbí a stěžují si. Přečtěte si
+[názor Linuse Torvaldse][mergealg], proč tomu tak je.
 
-K tomu, aby výsledky vaší práce na open source projektech byly snadno
-Dostupné pro ostatní je užitečné založit si vlastní repozitář, odkud
-si budou moct ostatní vaše změny stáhnout.
+[mergealg]:http://stackoverflow.com/questions/612580/how-does-git-solve-the-merging-problem/612747#612747
 
-1. [Zaregistrujte se][reg] na [repo.or.cz][roc]. K repozitáři na
-   repo.or.cz se přistupuje protokolem SSH a autorizace se provádí na
-   základě veřejných klíčů.
-   
-   1. Pokud žádný klíč nemáte, vytvořte si ho příkazem 
-   
-          ssh-keygen
+[kdiff3]:http://kdiff3.sourceforge.net/
 
-      Příkaz se vás zeptá kam klíč uložit. Výchozí volba vám zpočátku
-      bude stačit. Dále se zeptá na heslo (passphrase) k vašemu
-      privátnímu klíči. Pokud žádné heslo nezadáte, bude se moct
-      kdokoli, kdo se dostane k souboru s vaším klíčem (např.
-      administrátor školních serverů), autorizovat jako vy.
-   
-   2. Pokud jste se rozhodli chránit klíč heslem, je otravné zadávat
-      heslo vždy, když klíč používáte. Naštěstí existuje program
-      `ssh-agent`, který uchovává odheslované klíče v paměti a
-      poskytuje je vždy, když je nějaký oprávněný program potřebuje.
-      Vy tak zadáte heslo jen jednou a to když předáváte klíč
-      ssh-agentovi příkazem
+Repozitář na GitHubu
+--------------------
 
-          ssh-add
+K tomu, aby výsledky vaší práce na open source projektech byly snadno
+dostupné pro ostatní je užitečné založit si vlastní repozitář, odkud
+si budou moct ostatní vaše změny stáhnout.
 
-[reg]:http://repo.or.cz/reguser.cgi
-[roc]:http://repo.or.cz/
+1. Zaregistrujte se na [GitHubu](https://github.com/). V závislosti na
+   tom, jakým protokolem chcete k repozitářům na GitHubu přistupovat
+   si nastavte buď [password caching][passcache] (pro HTTP) nebo
+   [SSH klíče][sshkeys] (pro SSH).
 
-2. Vytvoření repozitáře na repo.or.cz.
+[passcache]:https://help.github.com/articles/set-up-git#password-caching   
+[sshkeys]:https://help.github.com/articles/generating-ssh-keys
 
-   Můžete založit buď [nový projekt][new] a nebo udělat tzv.
-   [fork existujícího projektu][forkmc]. Pro oba typy projektů můžete
-   zvolit zda bude repozitář pouze automaticky aktualizovanou kopií
-   jiného repozitáře (*mirror mode*) a nebo zda-li bude možné do něj přímo
-   ukládat nové commity (*push mode*).
+2. Vytvoření repozitáře na GitHubu. Můžete založit buď
+   [nový projekt][new] nebo udělat tzv. "fork" existujícího projektu.
    
-   Pro účely tohoto cvičení si
-   [založte fork][forkmc] [Midnight commanderu][w/osp.git] v *Push módu*, který se
-   bude jmenovat podle vašeho loginu. Do tohoto repozitáře pak
-   nahrajete úkol z dnešního cvičení.
+   Pro účely tohoto cvičení si [založte fork][forkmc]
+   [Midnight commanderu][osp-mc]. Do takto vytvořeného repozitáře pak
+   nahrajete vypracovaný úkol z dnešního cvičení.
    
-3. Do vašeho vzdáleného repozitáře můžete nahrát vaší větev některým z
-   těchto způsobů
+3. Do svého repozitáře na GitHubu nahrajete větev z lokálního
+   repozitáře některým z těchto způsobů:
 
-       git push ssh://<mujlogin>@repo.or.cz/srv/git/midnight-commander/osp/<mujfork>.git homework
-   nebo        
+       git remote add github https://github.com/<mujlogin>/mc.git
+       git push github HEAD:homework
+   nebo
 
-       git remote add repo-or-cz ssh://<mujlogin>@repo.or.cz/srv/git/midnight-commander/osp/<mujfork>.git
-       git push repo-or-cz homework
+       git push https://github.com/<mujlogin>/mc.git homework
+   nebo
+
+       git push ssh://git@github.com/<mujlogin>/mc.git homework
+
+[new]:https://github.com/new
+[osp-mc]:https://github.com/CTU-OSP/mc
+[forkmc]:https://github.com/CTU-OSP/mc/fork
 
-[new]:http://repo.or.cz/regproj.cgi
-[forkmc]:http://repo.or.cz/regproj.cgi?fork=midnight-commander/osp.git
 
 Zadání
 ======
 
 Proveďte sloučení větve `ssh://git@rtime.felk.cvut.cz/osp/mc
-only-directories` s aktuální vývojovou větví `origin/master`. Výsledek
-uložte do [vámi vytvořeného repozitáře (forku) na repo.or.cz][forkmc]
-do větve `homework`.
-
-[w/osp.git]:http://repo.or.cz/w/midnight-commander/osp.git
+only-directories` s aktuální vývojovou větví Midnight Commanderu
+(`origin/master`). Výsledek musí jít zkompilovat a musí obsahovat
+funkcionalitu přidanou do větve `only-directories`. Výsledek uložte do
+[vámi vytvořeného repozitáře (forku) na GitHubu][forkmc] do větve
+`homework`.