22
0
Bifurcation 0
wiki/HowtoGit.md

1105 lignes
27 KiB
Markdown
Brut Lien permanent Vue normale Historique

2018-04-12 16:57:50 +02:00
---
categories: git développement
2016-12-17 21:06:03 +01:00
title: Howto Git
...
* Documentation: <https://git-scm.com/doc>
* À voir : <https://youtu.be/4XpnKHJAok8>
2023-07-28 17:56:06 +02:00
* Statut de cette page : prod / bullseye
2016-12-17 21:06:03 +01:00
2016-12-18 01:07:31 +01:00
[Git](https://git-scm.com/) est un logiciel de gestion de code source, créé en 2005 par Linus Torvalds.
2016-12-17 21:06:03 +01:00
## Installation
~~~
2016-12-20 23:35:24 +01:00
# apt install git gitg
2023-07-28 17:56:06 +02:00
$ git --version
git version 2.30.2
2016-12-17 21:06:03 +01:00
~~~
2016-12-20 23:35:24 +01:00
Configuration minimale via `~/.gitconfig` :
2016-12-17 21:06:03 +01:00
~~~
[user]
2016-12-20 23:35:24 +01:00
name = John Doe
2016-12-17 21:06:03 +01:00
email = jdoe+git@example.com
[pull]
rebase = true
[push]
default = simple
[core]
editor = vim
2016-12-17 21:06:03 +01:00
~~~
## Commandes de base
2016-12-20 23:35:24 +01:00
### Utilisation et pages de manuel
2016-12-18 01:12:24 +01:00
2016-12-20 23:35:24 +01:00
Les commandes Git s'utilisent sous la forme `git <commande> [options]`
Pour chaque commande, une page de manuel *git-<commande>* est disponible. Par exemple pour `git add` faire `man git-add`.
2016-12-18 01:12:24 +01:00
2016-12-17 21:06:03 +01:00
### Créer un dépôt
~~~
2016-12-17 21:06:03 +01:00
$ mkdir foo
$ cd foo
$ git init
~~~
2018-02-06 15:04:05 +01:00
>> Note : dans le cas où on crée un dépôt en mode « serveur », on utilisera l'argument `--bare`.
2016-12-18 01:01:05 +01:00
### Cloner un dépôt
2016-12-17 21:06:03 +01:00
2016-12-20 23:35:24 +01:00
Plusieurs méthodes d'accès pour récupérer un dépôt : ssh://, http(s)://, git://, file:// etc.
2016-12-17 21:06:03 +01:00
~~~
$ git clone ssh://git.example.com/path/projet.git
2016-12-17 21:06:03 +01:00
$ git clone https://git.example.com/path/projet
$ git clone git://git.example.com/path/projet.git
$ git clone file:///path/projet
~~~
### Travailler sur un dépôt local
Ajouter un nouveau fichier :
~~~
2016-12-17 21:06:03 +01:00
$ touch main.c
$ git add main.c
$ git commit -v
~~~
Modification d'un fichier existant :
~~~
2016-12-17 21:06:03 +01:00
$ vi main.c
$ git add main.c
$ git commit -v
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
2016-12-20 23:35:24 +01:00
*Note* : si l'on souhaite faire un commit de l'ensemble des fichiers modifiés (et suivis) par git, on peut utiliser la commande `git
commit -a` sans avoir à utiliser `git add`. Néanmoins c'est une habitude à éviter car on risque d'inclure dans le commit des modifications non souhaitées.
2016-12-17 21:06:03 +01:00
2017-03-09 18:18:24 +01:00
Supprimer un fichier du dépôt (et non en local) :
~~~
$ git rm --cached fichier
~~~
2016-12-17 21:06:03 +01:00
Voir l'état du dépôt local (fichiers non commités, etc.) :
~~~
2016-12-17 21:06:03 +01:00
$ git status
2016-12-20 23:35:24 +01:00
$ git status -s -b
2016-12-17 21:06:03 +01:00
~~~
Voir les derniers commits du dépôt local :
~~~
2016-12-17 21:06:03 +01:00
$ git log
~~~
2016-12-20 23:35:24 +01:00
### pull/push avec un dépôt distant
2016-12-17 21:06:03 +01:00
Si l'on a cloné un dépôt existant, un lien est automatiquement créé entre le dépôt local créé et le dépôt distant (référencé comme *origin*).
Pour récupérer en local les derniers changements du dépôt distant :
~~~
2016-12-17 21:06:03 +01:00
$ git pull --rebase origin
~~~
*Note* : l'option `--rebase` est désormais le défaut mais par pédagogie on conseille de la mettre explicitement.
Pour envoyer ses modifications locales vers le dépôt référencé comme distant :
~~~
2016-12-17 21:06:03 +01:00
$ git push origin
~~~
### Gestion des branches
Par défaut, certains outils utilisent une branche nommée *master*.
Cette branche existe donc souvent au sein d'un dépôt, mais il faut
garder en tête que c'est une convention, rien n'oblige à en avoir une.
2016-12-17 21:06:03 +01:00
Lister les branches existantes et connaître sa branche courante :
~~~
2016-12-17 21:06:03 +01:00
$ git branch -a
~~~
2016-12-20 23:35:24 +01:00
Passer d'une branche à une autre dans son dépôt local :
2016-12-17 21:06:03 +01:00
~~~
2016-12-20 23:35:24 +01:00
$ git checkout myfeature
$ git checkout master
2016-12-17 21:06:03 +01:00
~~~
2016-12-20 23:35:24 +01:00
Créer une branche *myfeature* à partir de la branche *master* :
2016-12-17 21:06:03 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git checkout master
2016-12-20 23:35:24 +01:00
$ git branch myfeature master
2016-12-17 21:06:03 +01:00
~~~
2017-07-07 15:41:28 +02:00
Renommer la branche courante :
~~~
$ git branch -m <nouveau nom>
~~~
Renommer une branche autre que la branche courante :
~~~
$ git branch -m <ancien nom> <nouveau nom>
~~~
2016-12-20 23:35:24 +01:00
Travailler sur la branche *myfeature* puis [merger](#git-merge) son travail dans la branche *master* :
2016-12-17 21:06:03 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git checkout master
$ git merge --no-ff myfeature
~~~
Pousser une branche locale vers le dépôt référencé comme distant :
~~~
2016-12-18 01:01:05 +01:00
$ git push origin myfeature
2016-12-17 21:06:03 +01:00
~~~
2016-12-18 01:01:05 +01:00
Supprimer une branche locale et distante :
2016-12-17 21:06:03 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git branch -d myfeature
$ git push origin :myfeature
~~~
2019-01-17 15:45:10 +01:00
Supprimer les branches locales qui ne sont pas présentes sur le dépôt distant :
~~~
$ git fetch -p
~~~
2022-04-28 10:14:20 +02:00
### Gestion groupée
`mr(1)` (paquet [myrepos](https://myrepos.branchable.com/) dans Debian)
permet de gérer plusieurs dépôts Git (entre autres) de façon unifiée.
Pour ajouter un dépôt à `~/.mrconfig` il suffit de lancer la commande
suivante depuis le répertoire du dépôt.
~~~
$ mr register
~~~
2022-04-28 10:18:28 +02:00
Ensuite, la commande suivante (ou plus court, `mr up`) permet de mettre à jour
2022-04-28 10:14:20 +02:00
tous les dépôts enregistrés dans les sous-répertoires. La mise à jour
peut aussi être réalisée en parallèle (`mr -j5 up` lance cinq tâches en
parallèle).
2022-04-28 10:18:28 +02:00
~~~
$ mr update
~~~
2022-04-28 10:14:20 +02:00
Il est possible de récupérer le fichier de configuration `~/.mrconfig`
pour réinitialiser rapidement sur une nouvelle machine les dépôts que
2022-04-28 10:18:28 +02:00
l’on utilise avec `mr checkout` (ou `mr co`).
2022-04-28 10:14:20 +02:00
2016-12-17 21:06:03 +01:00
## Commandes avancées
2016-12-18 01:01:05 +01:00
### Afficher l'historique
Affichage de l'historique de différentes façons :
~~~
$ git log
$ git log -p
$ git log --stat
$ git log --summary
$ git log --color
$ git log --graph
2022-05-11 17:57:06 +02:00
$ git log --graph --color --decorate
$ git log --graph --color --decorate --oneline
$ git log --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset'
~~~
2018-01-22 15:21:50 +01:00
Afficher seulement les fichiers modifié :
~~~
$ git log --name-only
$ git show --name-only COMMIT
~~~
On peut notamment combiner toutes ces options dans un alias à mettre dans `.gitconfig` :
~~~
[alias]
2016-12-18 00:10:01 +01:00
lg = log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset'
~~~
2016-12-20 23:35:24 +01:00
On peut aussi utiliser *whatchanged* qui va lister tout ce qui a changé :
~~~
$ git whatchanged
$ git whatchanged -p
~~~
2016-12-20 23:35:24 +01:00
Voir l'avant-dernier commit :
~~~
$ git show HEAD~1
~~~
2016-12-20 23:35:24 +01:00
Voir le fichier *foo/bar* tel qu'il était dans l'avant-dernier commit :
~~~
$ git show HEAD~1:foo/bar
~~~
Pour voir ce qu'il s'est passé entre deux commits :
~~~
$ git show HEAD~8..HEAD
$ git show -p HEAD~8..HEAD
~~~
Afficher les _commits_ fait par `jdoe` aujourd’hui:
~~~
$ git log --oneline --no-decorate --since 00:00 --author jdoe
~~~
2023-08-04 13:57:39 +02:00
> On peut voir graphiquement l'historique avec différents outils, par exemple *gitg*, *gitk* ou *tig* :
>
> ~~~
> # apt install gitk gitg tig
> $ gitg
> $ gitk --all
> $ tig
> ~~~
2016-12-17 21:06:03 +01:00
### Modifier l'historique
2016-12-20 23:35:24 +01:00
/!\\ Les modifications de l'historique ne doivent avoir lieu que si cela n'a pas été pushé vers un dépôt partagé !
2016-12-17 21:06:03 +01:00
Modifier son dernier message de commit :
~~~
2016-12-17 21:06:03 +01:00
$ git commit --amend
~~~
Modifier son dernier commit :
~~~
2016-12-17 21:06:03 +01:00
$ vi main.c
$ git add main.c
$ git commit --amend
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
Modifier son avant-dernier commit :
~~~
2016-12-17 21:06:03 +01:00
$ git rebase -i HEAD^^
2016-12-22 14:29:13 +01:00
… remplacer « pick » par « edit » pour le commit à modifier
2016-12-17 21:06:03 +01:00
$ vi main.c
$ git add main.c
$ git commit --amend
$ git rebase --continue
~~~
*Note* : On peut remonter au Nième commit en utilisant *HEAD~N*
### Picorer un commit d'une autre branche (cherry-pick)
2016-12-17 21:06:03 +01:00
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-cherry-pick>
Récupérer un commit d'une autre branche dans master :
~~~
2016-12-20 23:35:24 +01:00
$ git checkout master
2016-12-17 21:06:03 +01:00
$ git cherry-pick <SHA1 du commit>
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
2017-06-12 10:33:05 +02:00
Si tout se passe bien, il ne demandera rien de plus sauf s'il y a des conflits. Dans ce cas, il faut éditer les fichiers où la commande `git status` indique "modifié des deux côtés : conflit.txt".
Après avoir effectué ces modifications, il faudra lancer la commande suivante pour confirmer l'action :
~~~
$ git cherry-pick --continue
~~~
2017-06-12 10:42:02 +02:00
Sinon pour tout annuler :
2017-06-12 10:33:05 +02:00
~~~
2017-06-12 10:42:02 +02:00
$ git cherry-pick --abort
2017-06-12 10:33:05 +02:00
~~~
2016-12-17 21:06:03 +01:00
### gitignore
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/gitignore>
2016-12-17 21:06:03 +01:00
Créer un fichier `.gitignore` à la racine pour ignorer certains fichiers/chemins :
2016-12-18 01:01:05 +01:00
2016-12-17 21:06:03 +01:00
~~~
$ cat .gitignore
test.php
htdocs/foo/bar
2016-12-20 23:35:24 +01:00
foo/bar*
2016-12-17 21:06:03 +01:00
~~~
2017-11-14 09:59:31 +01:00
> **Note** : Le fichier `.gitignore` se commit dans le dépôt.
2017-11-14 09:59:04 +01:00
> **Note** : Si on veut ignorer un fichier déjà commité, il faudra le supprimer de l'indexe avec `git rm --cached <file>`.
2016-12-17 21:06:03 +01:00
2016-12-30 15:00:46 +01:00
On peut également avoir un fichier `~/.config/git/ignore` qui sera valable pour tous les dépôts Git.
2016-12-17 21:06:03 +01:00
### Ranger temporairement son travail (git stash)
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-stash>
2016-12-22 14:29:13 +01:00
Cela permet d'avoir un buffer pour mettre « en pause » des modifications non commitées :
2016-12-17 21:06:03 +01:00
~~~
2016-12-17 21:06:03 +01:00
…hack…hack…
$ git stash save
~~~
On peut lister ce buffer :
~~~
2016-12-17 21:06:03 +01:00
$ git stash list
stash@{0}: WIP on dev: fb1fa70… m
stash@{1}: WIP on dev: fb1fa70… m
~~~
2016-12-30 15:15:39 +01:00
Pour appliquer la dernière modification stockée :
2016-12-17 21:06:03 +01:00
~~~
2016-12-29 14:08:34 +01:00
$ git stash pop
2016-12-17 21:06:03 +01:00
~~~
Pour purger le buffer sans l'appliquer :
~~~
2016-12-17 21:06:03 +01:00
$ git stash clear
~~~
2016-12-30 15:15:39 +01:00
Pour voir une des modifications :
~~~
$ git stash show -p stash@{0}
~~~
2018-02-20 16:38:00 +01:00
Pour retrouver un stash pop grâce à gitk :
~~~
gitk --all $( git fsck --no-reflog | awk '/dangling commit/ {print $3}' )
~~~
### git diff
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-diff>
2016-12-26 21:02:09 +01:00
Voir les modifications locales non commitées et non indexés :
~~~
$ git diff
~~~
2016-12-20 23:35:24 +01:00
Voir les modifications locales *suivies* (ajoutées avec *git add*) :
~~~
$ git diff --cached
~~~
Voir les modifications entre deux commits, ou entre deux branches :
~~~
$ git diff HEAD^ HEAD
$ git diff HEAD~8 HEAD^^
$ git diff myfeature master
~~~
2017-07-23 01:05:51 +02:00
*Note* : si le 2ème commit est *HEAD* on peut ne pas le mentionner, `git diff HEAD^` montrera les modifications du dernier commit
2016-12-20 23:35:24 +01:00
Voir les modifications entre deux commits, mais uniquement pour un fichier *foo* :
2016-12-20 01:50:15 +01:00
~~~
2016-12-20 01:50:15 +01:00
$ git diff HEAD~8..HEAD^^ -- foo
~~~
Avoir un diff inversé (pratique pour faire préparer un revert partiel par exemple) :
~~~
$ git diff -R
~~~
2017-07-23 01:05:51 +02:00
Avoir des stats entre 2 commits ou branches :
~~~
$ git diff --stat HEAD~8 HEAD^^
$ git diff --stat myfeature master
~~~
2017-07-27 21:05:34 +02:00
Voir les modifications en mode "mots" plutôt qu'en mode "ligne" (très pratiques pour voir les changements au sein d'une ligne) :
~~~
$ git diff --word-diff
~~~
2017-07-23 01:05:51 +02:00
Voir les modifications depuis un certain temps sur un dépôt complet ou sur un fichier précis :
~~~
$ git diff HEAD 'HEAD@{3 hours ago}'
$ git diff HEAD 'HEAD@{3 weeks ago}' -- foo/bar.txt
~~~
2016-12-20 23:35:24 +01:00
### git pull/fetch
<https://git-scm.com/docs/git-pull>
`git pull` est une commande qui effectue un rapatriement des données (`git fetch`) puis l'intégration de ces données via `git rebase` (par défaut) ou `git merge`.
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-fetch>
Dans certains cas il est pratique de faire un simple `git fetch`, notamment si l'on veut faire des manipulations complexes ou si l'on veut avoir toutes les données pour travailler hors ligne sans rien changer à l'état actuel de sa *working copy*.
### git push
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-push>
Pousser toutes ses branches d'un coup (ce qui est déconseillé en général) :
~~~
$ git push --all origin
~~~
2016-12-20 23:35:24 +01:00
Si l'on a une branche locale nommée *foo* et que l'on veut la pousser dans la branche nommée *bar* du dépôt distant :
~~~
$ git push origin foo:bar
~~~
/!\\ Attention, il ne faut jamais modifier un historique qui a été pushé vers un dépôt partagé. Néanmoins dans certaines situations exceptionnelles (un mot de passe ou un email qui aurait été mis par erreur) on peut être amené à faire un `push --force` :
~~~
$ git push -f origin
~~~
2016-12-20 23:35:24 +01:00
Il faudra ensuite que chaque utilisateur du dépôt soit prévenu et accepte d'écraser leur dépôt local (en faisant ou vérifiant les modifications d'historiques) :
~~~
$ git fetch
$ git reset origin
~~~
### git checkout
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-checkout>
Pour avoir le dépôt tel qu'il était à un commit :
~~~
$ git checkout <SHA1 du commit>
~~~
2018-04-12 16:57:21 +02:00
Ou, un fichier spécifique tel qu'il était à un commit :
~~~
$ git checkout <SHA1 du commit> -- <fichier>
~~~
2017-12-07 20:35:07 +01:00
On est alors dans l'état « HEAD détachée ». Pour revenir dans l'état précédent :
~~~
$ git checkout -
~~~
2016-12-22 14:29:13 +01:00
Pour se remettre sur la version courante :
~~~
$ git checkout master
~~~
2016-12-18 01:34:27 +01:00
Pour créer une branche et switcher directement dans cette nouvelle branche, on utilise l'option `-b` :
~~~
$ git checkout -b myfeature
~~~
2016-12-26 21:02:09 +01:00
Pour annuler toutes les modifications d'un fichier foo/ non indexé :
~~~
$ git checkout foo/
~~~
2016-12-26 21:02:09 +01:00
### git branch
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-branch>
Une branche est en fait la création une déviation, un commit qui a deux *enfants*.
On peut ainsi créer une branche à partir de n'importe quel commit :
~~~
$ git branch newbranch e150b8517a694a2d4816cff95ef612086d644f67
~~~
Pour supprimer la branche *foo* sur un dépôt distant non cloné :
~~~
$ git push ssh://git.example.com/projet.git :foo
~~~
Pour récupérer une nouvelle branche depuis le dépôt référencé comme distant :
~~~
$ git remote update
~~~
2016-12-20 23:35:24 +01:00
### git reset/clean
<https://git-scm.com/docs/git-reset>
<https://git-scm.com/docs/git-clean>
/!\\ Certaines commandes peuvent provoquer une perte de données !
2016-12-26 21:02:09 +01:00
Pour supprimer toutes les modifications non commitées et les fichiers/répertoires non indexés :
~~~
$ git reset --hard
$ git clean -f -d
~~~
2016-12-20 23:35:24 +01:00
On peut aussi `git reset` sur des commits précédents (*HEAD^*,*HEAD~N*,*<SHA1 du commit>*).
Ou même sur une branche distante comme *origin/master* par exemple (ce qui est pratique si l'historique de la branche distante a été modifié).
2016-12-26 21:02:09 +01:00
Pour désindexer des modifications d'un fichier :
~~~
2016-12-26 21:02:09 +01:00
$ git reset HEAD <fichier>
~~~
### git add
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-add>
Pour ajouter tout un répertoire et son contenu :
~~~
$ git add foo/
~~~
Pour choisir ce que l'on veut ajouter pour le prochain commit :
~~~
$ git add -p
~~~
### git merge
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-merge>
Un merge consiste à créer un commit qui aura deux parents, et permet ainsi de fusionner deux branches existantes.
2016-12-22 14:29:13 +01:00
Quand un merge est très simple, c’est-à-dire que cela rajoute simplement des commits sur une branche qui n'a pas bougé entre temps, on n'a pas besoin de créer un commit pour fusionner, on appelle cela un merge **fast-forward**. Cela se fait automatiquement avec la commande `git merge`. Notons que l'on peut vouloir tout de même avoir un commit pour marquer le coup et forcer un commit de merge avec l'option `git merge --no-ff`.
Quand un merge n'est pas simple, Git peut adopter plusieurs stratégies (resolve, recursive, ours, theirs, patience, etc.). Il est probable que cela génère des conflits qui devront être résolus manuellement.
### git apply
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-apply>
`git apply` permet d'appliquer un diff.
On peut utiliser une option pour exclure l'application de certain fichier du diff :
~~~
$ git apply --exclude=debian/changelog /tmp/foo.diff
~~~
### git blame
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-blame>
Pour voir qui a modifié les lignes d'un fichier *foo/bar* :
~~~
$ git blame foo/bar
~~~
2023-11-16 14:41:18 +01:00
Si l'on veut faire un blame sur une portion de fichiers modifiées plusieurs fois, on peut d'abord `git checkout` avant :
~~~
$ git checkout <SHA1 d'un commit dans le passé>
$ git blame foo/bar
$ git checkout -
~~~
### git revert
2017-08-28 22:35:49 +02:00
<https://git-scm.com/docs/git-revert>
Pour effectuer les modifications inverses de celles effectuées (et donc revenir à l'état précédent :
~~~
$ git revert <SHA1 du commit>
~~~
2017-10-02 23:43:50 +02:00
### git tag
Ajouter et pousser un tag à l'endroit où l'on est :
~~~
$ git tag -a foo -m "version foo"
$ git push origin foo
~~~
Lister les tags :
~~~
$ git tag
foo
~~~
2017-12-08 10:54:36 +01:00
Changer un tag foo en bar sur un dépôt distant :
~~~
$ git co foo && git tag bar && git tag -d foo && git push origin :foo && git push --tags
~~~
2023-08-31 15:23:40 +02:00
### `git grep`
Faire une recherche comme le ferait `grep`, mais sans parcourir le répertoire `.git` :
~~~
$ git grep 'hel\+o there'
$ git grep -E 'hel+o there'
$ git grep 'regexp' répertoire/
$ git grep 'regexp' :^répertoire-à-ignorer/
~~~
### .git/config
2016-12-20 23:35:24 +01:00
<https://git-scm.com/docs/git-config>
La configuration d'un dépôt se trouve dans le fichier `.git/config`
On peut éditer ce fichier ou utiliser des commandes pour le faire.
Pour ajouter un dépôt distant :
~~~
$ git remote add origin2 ssh://git.example.com/path/projet.git
~~~
Pour lister les dépôts distants configurés :
~~~
$ git remote
~~~
2016-12-22 14:29:13 +01:00
### Échanger des commits sous forme de patchs Git
2016-12-17 21:06:03 +01:00
Pour transmettre ses 3 derniers commits, on peut générer 3 patches qui contiendront les diffs ainsi que les messages de commit :
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git format-patch -3
~~~
Si l'on a ces 3 patches, on peut les appliquer sur son dépôt local ainsi :
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git am 000*.patch
~~~
2016-12-18 01:01:05 +01:00
### hooks
On peut gérer des hooks à différents moments (pre-commit, post-commit, pre-push, post-push, etc.),
par exemple pour générer des emails de notification.
Voir dans le répertoire `.git/hooks/`.
2017-03-21 21:02:22 +01:00
On peut par exemple s'en servir pour [activer des mails de commit](#mettre-en-place-des-notifications-de-push)
2016-12-22 14:29:13 +01:00
### dépôt « bare »
2016-12-22 14:29:13 +01:00
Un dépôt classique possède un répertoire `.git/` qui contient toutes les données et méta-données, ainsi qu'une *working copy* de la branche courante.
Quand on crée un dépôt ayant vocation à servir de dépôt central, il est préférable de ne pas avoir de *working copy* : il s'agira alors d'un **bare repository** que l'on peut initier avec la commande :
~~~
$ mkdir foo
$ cd foo
$ git init --bare
~~~
2016-12-17 21:06:03 +01:00
## Workflow de travail
Il existe plusieurs workflows possibles en travaillant avec Git.
### Le modèle Git branching
Voir <http://nvie.com/posts/a-successful-git-branching-model/>
2016-12-20 23:35:24 +01:00
L'idée est de ne jamais toucher à *master*, sauf hotfixes. Pour le reste on le fait dans *dev*.
2016-12-17 21:06:03 +01:00
Et pour les grosses features on le fait dans une branche, nommée avec le nom de la feature.
## Plomberie
<https://git-scm.com/book/fr/Git-Commands-Plumbing-Commands>
La plomberie de Git consiste à réaliser des commandes bas niveau
manipulant tout ce qui se trouve dans le répertoire `.git/` d'un dépôt.
2016-12-18 00:13:47 +01:00
Les données brutes sont dans le répertoire `.git/objects/` qui contient
de nombreux fichiers : à chaque commit correspond un fichier nommé en fonction
de l'empreinte SHA1 du commit et contenant les données compressées.
Les données comprennent notamment la référence au(x) commit(s) *parent*
2016-12-22 14:29:13 +01:00
ce qui permet d’avoir des liens entre les commits.
2016-12-18 00:13:47 +01:00
Observons `.git/refs/` qui contient des pseudos-pointeurs (fichier texte d'une seule ligne contenant un SHA1 ou une autre référence) :
2016-12-20 01:59:43 +01:00
2016-12-18 00:13:47 +01:00
* un tag est simplement un pointeur vers un commit ;
* une branche est également un pointeur vers un commit, la différence est qu'il se déplace à chaque nouveau commit dans la branche.
Directement dans `.git/` on a également *HEAD* (et *FETCH_HEAD*, *ORIG_HEAD*) qui sont aussi des pseudo-pointeurs, qui changent notamment quand on change de branche ou pendant un *rebase*.
Si l'on veut mettre à jour ces pseudo-pointeurs, il faut utiliser `git update-ref`.
Observons `.git/logs/` qui contient l'historique de ce qui a été fait dans le dépôt.
Cet historique est notamment accessible avec la commande `git reflog`.
## FAQ
2016-12-17 21:06:03 +01:00
2017-02-24 15:44:21 +01:00
### Partager un dépôt en HTTP - simplement
[https://www.kernel.org/pub/software/scm/git/docs/git-http-backend.html](https://www.kernel.org/pub/software/scm/git/docs/git-http-backend.html)
Le dépôt git est dans /home/git/projets/projet.git, et le serveur web est Apache2.4.
~~~{.bash}
SetEnv GIT_PROJECT_ROOT /home/git/
SetEnv GIT_HTTP_EXPORT_ALL
ScriptAlias /git/ /usr/lib/git-core/git-http-backend/
Alias /git /home/git/projets
<Location /git>
AuthType Basic
AuthName "Git HTTP Access"
AuthUserFile /etc/apache2/htpasswd_git
Require user git
</Location>
~~~
Pour cloner le dépot :
~~~{.bash}
$ git clone http://git@domain:port/git/projet
~~~
2016-12-17 21:06:03 +01:00
### Partager un dépôt avec plusieurs utilisateurs
2016-12-22 14:29:13 +01:00
Avec un dépôt *foo* existant, on autorisera les utilisateurs que s’ils appartiennent au groupe *git* :
2016-12-17 21:06:03 +01:00
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
# cd foo
# git config core.sharedRepository group
# addgroup git
# chgrp -R git .
# chmod g=rwXs,o= -R .
# chmod g=rwX -R . # astuce pour garder le +s sur les répertoires
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
### Importer un dépôt SVN dans GIT
2016-12-22 14:29:13 +01:00
Ce script permet de récupérer la liste des auteurs SVN, modifiez-la comme voulu.
2016-12-17 21:06:03 +01:00
2016-12-18 01:01:05 +01:00
~~~{.bash}
2016-12-17 21:06:03 +01:00
#!/usr/bin/env bash
authors=$(svn log -q | grep -e '^r' | awk 'BEGIN { FS = "|" } ; { print $2 }' | sort | uniq)
for author in ${authors}; do
echo "${author} = Prenom Nom <jdoe@example.com>";
done
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
On lance ensuite la commande suivante :
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git svn --authors-file=path/to/authors_file clone svn+ssh://svn.example.com/path/to/repo
~~~
2016-12-18 01:01:05 +01:00
2016-12-17 21:06:03 +01:00
### Importer un dépôt CVS dans GIT
Lancer la commande suivante :
~~~
2016-12-17 21:06:03 +01:00
$ git cvsimport -C repo_git -r cvs -k -vA path/to/authors_file -d user@hostname:/path/to/cvsroot repo
~~~
### Importer un dépôt Arch dans GIT
Lancer la commande suivante :
~~~
$ git-archimport -v foo@arch.example.com--branch
~~~
2016-12-17 21:06:03 +01:00
### Convertir un dépôt en utf8
Créer un fichier exécutable dans `/tmp/recode-all-files` :
2016-12-18 01:01:05 +01:00
2016-12-17 21:06:03 +01:00
~~~{.bash}
#!/bin/sh
find . -type f -print | while read f; do
mv -i "$f" "$f.recode.$$"
iconv -f iso-8859-1 -t utf-8 < "$f.recode.$$" > "$f"
rm -f "$f.recode.$$"
done
~~~
Puis exécuter la commande suivante dans votre dépôt :
~~~
2016-12-17 21:06:03 +01:00
$ git filter-branch --tree-filter /tmp/recode-all-files HEAD
~~~
Exécuter ensuite la commande suivante pour convertir les messages de commit :
~~~
2016-12-17 21:06:03 +01:00
$ git filter-branch --msg-filter 'iconv -f iso-8859-1 -t utf-8' -- --all
~~~
### Push vers un non-bare repository
Ceci est évidemment déconseillé, car cela mettra aussi à jour les fichiers, ce qui nécessite
de faire un `git reset --hard`. Mais si l'on veut tout de même le forcer :
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git push
Counting objects: 7, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (4/4), done.
Writing objects: 100% (4/4), 618 bytes, done.
Total 4 (delta 3), reused 0 (delta 0)
Unpacking objects: 100% (4/4), done.
remote: error: refusing to update checked out branch: refs/heads/master
remote: error: By default, updating the current branch in a non-bare repository
remote: error: is denied, because it will make the index and work tree inconsistent
remote: error: with what you pushed, and will require 'git reset --hard' to match
remote: error: the work tree to HEAD.
2016-12-18 01:01:05 +01:00
remote: error:
2016-12-17 21:06:03 +01:00
remote: error: You can set 'receive.denyCurrentBranch' configuration variable to
remote: error: 'ignore' or 'warn' in the remote repository to allow pushing into
remote: error: its current branch; however, this is not recommended unless you
remote: error: arranged to update its work tree to match what you pushed in some
remote: error: other way.
2016-12-18 01:01:05 +01:00
remote: error:
2016-12-17 21:06:03 +01:00
remote: error: To squelch this message and still keep the default behaviour, set
remote: error: 'receive.denyCurrentBranch' configuration variable to 'refuse'.
! [remote rejected] master -> master (branch is currently checked out)
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
2016-12-22 14:29:13 +01:00
Il faut ajouter dans la config du repository « distant » :
2016-12-17 21:06:03 +01:00
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
[receive]
denyCurrentBranch = warn
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
### Transformer un non-bare repository en bare repository
2016-12-22 14:30:17 +01:00
Il suffit de supprimer tous les fichiers sauf le `.git`, par exemple :
2016-12-17 21:06:03 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ rm -rf *
~~~
Puis d'indiquer dans la config du repository :
2016-12-18 01:01:05 +01:00
2016-12-17 21:06:03 +01:00
~~~
bare = true
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
### Mettre en place des notifications de push
Sous Debian, pour envoyer des notifications par email à git@example.com :
~~~
# chmod a+x /usr/share/doc/git-core/contrib/hooks/post-receive-email
$ cd /path/path/to/your/repository.git
$ ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
$ git hooks.mailinglist git@example.com
~~~
Pour recevoir les patches :
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git config hooks.showrev "git show -C %s; echo
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
### Ignorer les vérifications SSL
2016-12-20 23:35:24 +01:00
(à éviter autant que possible bien sûr)
2016-12-18 01:48:34 +01:00
~~~
2016-12-17 21:06:03 +01:00
$ git config --global http.sslverify "false"
2016-12-18 01:01:05 +01:00
~~~
2016-12-17 21:06:03 +01:00
### Nettoyage d'un dépôt Git
Quand on supprime des commits, ils ne sont pas vraiment supprimés du dépôt.
Cela offre l'avantage de pouvoir les retrouver en cas de besoin.
Si l'on veut gagner de la place, on peut aussi faire un nettoyage :
~~~
$ git repack
$ git gc
~~~
2021-06-16 18:49:48 +02:00
### Migrer un dépôt git
2016-12-17 21:06:03 +01:00
Il se peut qu'on change de forge (passage de gitolite à gitlab par
2021-06-16 18:53:00 +02:00
exemple) et il faut alors migrer les dépôts. Un moyen de faire :
2017-01-04 00:08:36 +01:00
~~~{.bash}
$ for branch in `git branch -a | grep remotes | grep -v HEAD | grep -v master`; do rbranch=$(echo $branch | tr '/' ' ' | awk '{print $3}') ; git checkout -b $rbranch $branch ; done
$ git remote add gitlab gitlab@gitlab.example.com:group/repo.git && git push gitlab --all && git remote remove origin && git remote rename gitlab origin && git push --set-upstream origin master
~~~
2017-01-04 00:07:23 +01:00
### Avoir des stats basiques
2017-01-04 00:07:23 +01:00
Il existe la commande shortlog pour avoir quelques stats sur un dépôt git
~~~
$ git shortlog -sne
~~~
2018-03-26 15:30:10 +02:00
### Supprimer un fichier du dépôt et non en local
~~~
$ git rm --cached file
~~~
### Supprimer le dernier commit
À faire avec précaution bien sûr :
~~~
$ git reset --hard HEAD^
2017-01-04 00:07:23 +01:00
~~~
2017-06-14 23:18:11 +02:00
### Troubleshooting bitbucket
Si soucis avec Bitbucket, notamment performance réseau, on peut tester :
~~~
$ git clone https://bitbucket.org/mirror/git.git
~~~
2017-06-14 23:26:59 +02:00
[Notamment Bitbucket a des performances mauvaises (ou nulles) en IPv6.](https://grosse.io/blog/posts/Fixing-slow-Bitbucket-git-connections-via-SSH)
2017-06-14 23:18:11 +02:00
2017-06-14 23:26:59 +02:00
Voir <https://confluence.atlassian.com/bbkb/troubleshooting-network-issues-389778693.html>
### Algorithme de diff
Un diff peut être présenté de différentes façons.
Exemple très simple, si le fichier original est :
~~~
[foo]
A
~~~
et le fichier modifié est :
~~~
[bar]
A
~~~
Le diff peut être :
~~~
-[foo]
+[bar]
~~~
ou :
~~~
-[foo]
-A
+[bar]
+A
~~~
…évidemment cet exemple très simple est juste pour démontrer qu'il peut y avoir des diffs différents pour une même modification.
Ainsi, on peut utiliser différents algorithmes de diff avec `git diff` ou `git show` : minimal, patience, histogram ou myers.
~~~
$ git diff --minimal
$ git diff --patience
$ git diff --histogram
$ git diff --diff-algorithm=myers
2018-02-06 15:04:05 +01:00
~~~
2018-02-14 13:46:50 +01:00
### alias
Voici des alias qui peuvent être intéressants :
~~~
2018-02-14 14:00:11 +01:00
d = diff --ignore-space-change --patience --no-prefix
# affiche le diff en mode "patience", sans les changements d'espaces et sans les prefix
2018-02-14 13:46:50 +01:00
2018-02-14 14:00:11 +01:00
dw = diff --word-diff
# affiche le diff en mode "word" qui met en évidence les changements au sein de chaque ligne
lg = log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative
# log des commits affichés avec une présentation riche mais compacte
cane = commit --amend --no-edit
# modifie le dernier commit sans éditer le message de commit
rf = !sh -c 'rm $1 && git checkout $1'
# restaure un fichier/emplacement depuis le dépôt
s = status --short --branch
# affiche un statut compacte
conflicts = !sh -c 'git status -sb | grep ^UU | sed "s/UU\\ //"'
# liste les fichiers ayant un conflit non résolu
resolve = !sh -c 'git conflicts && $EDITOR $(git conflicts) +\"/<<<<\"'
# ouvre les fichiers en conflit dans un éditeur (compatible Vim), positionné au bon endroit
~~~
### Quitter l'éditeur de texte sans que Git n'exécute l'action liée
Lorsque Git délègue à l'éditeur de texte la rédaction du message de commit (ou autre édition), si l'éditeur quitte avec un code de sortie 0, alors Git considère que tout va bien et exécute son action initiale (faire un commit par exemple). Si on veut que Git ne fasse pas cette action, il suffit de faire quitter l'éditeur avec un code de sortie > 0. Avec Vim, ça se fait avec la commande `:cq`.
2021-06-16 18:49:48 +02:00
Exemple concret de cette situation : on veut amender un commit auquel on a ajouté (ou retiré) certains éléments, mais au moment de rédiger le message on se rend compte qu'on en a trop ajouté (ou retiré). Un simple `:q!` dans Vim ne validera pas le message de commit mais validera le commit lui-même. C'est là qu'on peut sortir de Vim et annuler l'action de Git avec `:cq`.
## Troubleshooting
### Erreurs `cache entry has null sha1`, `bad index file sha1 signature` ou `index file corrupt`
~~~
# git fsck --full
Checking object directories: 100% (256/256), done.
error: bad index file sha1 signature
fatal: index file corrupt
~~~
Dans ce cas, les add et les commits ne se font plus. Il suffit de supprimer l'index, git le reconstruira proprement à la prochaine commande :
~~~
# rm .git/index
~~~