2020-06-22 10:22:19 +00:00
#+title : Phundrak’
2020-09-02 10:52:17 +00:00
#+author : Lucien “Phundrak” Cartier-Tilet
2020-06-22 10:22:19 +00:00
#+hugo_base_dir : ../
#+hugo_section : ./
#+hugo_categories : emacs linux conlanging orgmode
* Conlanging :@conlang:
** TODO Writing my conlanging docs with Emacs :emacs:conlanging:
* Emacs :@emacs:
** [EN] Automatic Meaningful Custom IDs for Org Headings :emacs:orgmode:
:PROPERTIES:
:EXPORT_FILE_NAME: better-custom-ids-orgmode
:EXPORT_DATE: 2020-06-06
:export_hugo_menu: :menu "main"
:END:
Spoiler alert, I will just modify a bit of code that already exists, go
directly to the bottom if you want the solution, or read the whole post if
you are interested in how I got there.
2020-06-25 15:06:20 +00:00
#+TOC: headlines 1 local
2020-06-22 10:22:19 +00:00
*** The issue
About two to three years ago, as I was working on a project that was meant
to be published on the internet, I looked for a solution to get fixed anchor
links to my various headings when I performed HTML exports. As some of you
may know, by default when an Org file is exported to an HTML file, a random
ID will be generated for each header, and this ID will be used as their
anchor. Here’
#+caption: Example org file
#+begin_src org :exports code
,#+title: Sample org file
,* First heading
Reference to a subheading
,* Second heading
Some stuff written here
,** First subheading
Some stuff
,** Second subheading
Some other stuff
#+end_src
And this is the result once exported to HTML (with a lot of noise removed
from ~<head>~ ):
#+caption: Output HTML file
#+BEGIN_SRC html
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en" >
<head >
<title >Sample org file</title >
<meta name="generator" content="Org mode" / >
<meta name="author" content="Lucien Cartier-Tilet" / >
</head >
<body >
<div id="content" >
<h1 class="title" >Sample org file</h1 >
<div id="outline-container-orgd8e6238" class="outline-2" >
<h2 id="orgd8e6238" ><span class="section-number-2" >1</span > First heading</h2 >
<div class="outline-text-2" id="text-1" >
<p >
Reference to a subheading
</p >
</div >
</div >
<div id="outline-container-org621c39a" class="outline-2" >
<h2 id="org621c39a" ><span class="section-number-2" >2</span > Second heading</h2 >
<div class="outline-text-2" id="text-2" >
<p >
Some stuff written here
</p >
</div >
<div id="outline-container-orgae45d6b" class="outline-3" >
<h3 id="orgae45d6b" ><span class="section-number-3" >2.1</span > First subheading</h3 >
<div class="outline-text-3" id="text-2-1" >
<p >
Some stuff
</p >
</div >
</div >
<div id="outline-container-org9301aa9" class="outline-3" >
<h3 id="org9301aa9" ><span class="section-number-3" >2.2</span > Second subheading</h3 >
<div class="outline-text-3" id="text-2-2" >
<p >
Some other stuff
</p >
</div >
</div >
</div >
</div >
</body >
</html >
#+END_SRC
As you can see, all the anchors are in the fomat of ~org[a-f0-9]{7}~ . First,
this is not really meaningful if you want to read the anchor and guess where
it will lead you. But secondly, these anchors will change each time you
export your Org file to HTML. If I want to share a URL to my website and to
a specific heading,… well I can’
document. And I don’ ~CUSTOM_ID~ property for each
one of my headings manually. So, what to do?
*** A first solution
A first solution I found came from [[https://writequit.org/articles/emacs-org-mode-generate-ids.html ][this blog post ]], where Lee Hinman
described the very same issue they had and wrote some Elisp code to remedy
that (it’
used their code in my Emacs configuration file in order to generate unique
custom IDs for my Org headers. Basically what the code does is it detects if
~auto-id:t~ is set in an ~#+OPTIONS~ header. If it is, then it will iterate
over all of the Org headers, and for each one of them it will insert a
~CUSTOM_ID~ , which is made from a UUID generated by Emacs. And tada! we get
for each header a
~h-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}~ custom ID
that won’
file, and only for headings which don’ ~CUSTOM_ID~ property.
Wohoo!
Except…
*** These headers are not meaningful
Ok, alright, that’ ’
CUSTOM_ID property manually anymore, it’
when I send someone a link like
~https://langue.phundrak.com/eittland#h-76fc0b91-e41c-42ad-8652-bba029632333~ ,
the first reaction to this URL is often something along the lines of “What
the fuck?”. And they’
anchor. How am I supposed to guess it links to the description of the vowels
of the Eittlandic language? (That’ ’
you won’
So, I went back to my configuration file for Emacs, and through some trial
and error, I finally found a way to get a consistent custom ID which is
readable and automatically set. With the current state of my code, what you
get is the complete path of the Org heading, all spaces replaced by
underscores and headings separated by dashes, with a final unique identifier
taken from an Emacs-generated UUID. Now, the same link as above will look
like
2020-09-02 10:52:17 +00:00
~https://langue.phundrak.com/eittland#Aperçu_structurel-Inventaire_phonétique_et_orthographe-Voyelles_pures-84f05c2c~ .
2020-06-22 10:22:19 +00:00
It won’ ’
guess it is way better than what we had before. I even added a safety net by
replacing all forward slashes with dashes. The last ID is here to ensure the
path will be unique in case we’
for one reason or another.
The modifications I made to the first function ~eos/org-id-new~ are minimal,
where I just split the UUID and get its first part. This is basically a way
to simplify it.
#+BEGIN_SRC emacs-lisp
(defun eos/org-id-new (&optional prefix)
"Create a new globally unique ID.
An ID consists of two parts separated by a colon:
- a prefix
- a unique part that will be created according to
`org-id-method'.
PREFIX can specify the prefix, the default is given by the
variable `org-id-prefix'. However, if PREFIX is the symbol
`none', don't use any prefix even if `org-id-prefix' specifies
one.
So a typical ID could look like \"Org-4nd91V40HI\"."
(let* ((prefix (if (eq prefix 'none)
""
(concat (or prefix org-id-prefix)
"-"))) unique)
(if (equal prefix "-")
(setq prefix ""))
(cond
((memq org-id-method
'(uuidgen uuid))
(setq unique (org-trim (shell-command-to-string org-id-uuid-program)))
(unless (org-uuidgen-p unique)
(setq unique (org-id-uuid))))
((eq org-id-method 'org)
(let* ((etime (org-reverse-string (org-id-time-to-b36)))
(postfix (if org-id-include-domain
(progn
(require 'message)
(concat "@"
(message-make-fqdn))))))
(setq unique (concat etime postfix))))
(t (error "Invalid `org-id-method'")))
(concat prefix (car (split-string unique "-")))))
#+END_SRC
Next, we have here the actual generation of the custom ID. As you can see,
the ~let~ has been replaced by a ~let*~ which allowed me to create the ID
2020-06-25 15:06:20 +00:00
with the variables ~orgpath~ and ~heading~ . The former concatenates the path
to the heading joined by dashes, and ~heading~ concatenates ~orgpath~ to the
name of the current heading joined by a dash if ~orgpath~ is not empty. It
will then create a slug out of the result, deleting some elements such as
forward slashes or tildes, and all whitespace is replaced by underscores. It
then passes ~heading~ as an argument to the function described above to
which the unique ID will be concatenated.
2020-06-22 10:22:19 +00:00
#+BEGIN_SRC emacs-lisp
(defun eos/org-custom-id-get (&optional pom create prefix)
"Get the CUSTOM_ID property of the entry at point-or-marker POM.
If POM is nil, refer to the entry at point. If the entry does not
have an CUSTOM_ID, the function returns nil. However, when CREATE
is non nil, create a CUSTOM_ID if none is present already. PREFIX
will be passed through to `eos/org-id-new'. In any case, the
CUSTOM_ID of the entry is returned."
(interactive)
(org-with-point-at pom
(let* ((orgpath (mapconcat #'identity (org-get-outline-path) "-"))
(heading (replace-regexp-in-string
2020-06-25 15:06:20 +00:00
"/\\|~\\|\\[\\|\\]" ""
2020-06-22 10:22:19 +00:00
(replace-regexp-in-string
2020-06-25 15:06:20 +00:00
"[[:space: ]]+" "_" (if (string= orgpath "")
2020-06-22 10:22:19 +00:00
(org-get-heading t t t t)
(concat orgpath "-" (org-get-heading t t t t))))))
(id (org-entry-get nil "CUSTOM_ID")))
(cond
((and id
(stringp id)
(string-match "\\S-" id)) id)
(create (setq id (eos/org-id-new (concat prefix heading)))
(org-entry-put pom "CUSTOM_ID" id)
(org-id-add-location id
(buffer-file-name (buffer-base-buffer)))
id)))))
#+END_SRC
The rest of the code is unchanged, here it is anyway:
#+BEGIN_SRC emacs-lisp
(defun eos/org-add-ids-to-headlines-in-file ()
"Add CUSTOM_ID properties to all headlines in the current file
which do not already have one.
Only adds ids if the `auto-id' option is set to `t' in the file
somewhere. ie, #+OPTIONS: auto-id:t"
(interactive)
(save-excursion
(widen)
(goto-char (point-min))
(when (re-search-forward "^#\\+OPTIONS:.*auto-id:t"
(point-max)
t)
(org-map-entries (lambda ()
(eos/org-custom-id-get (point)
'create))))))
(add-hook 'org-mode-hook
(lambda ()
(add-hook 'before-save-hook
(lambda ()
(when (and (eq major-mode 'org-mode)
(eq buffer-read-only nil))
(eos/org-add-ids-to-headlines-in-file))))))
#+END_SRC
Note that you *will need* the package ~org-id~ to make this code work. You
simply need to add the following code before the code I shared above:
#+BEGIN_SRC emacs-lisp
(require 'org-id)
(setq org-id-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
#+END_SRC
And that’ *and* persistent! The only
downside I found to this is when you move headings and their path is
modified, or when you modify the heading itself, the custom ID is not
automatically updated. I could fix that by regenerating the custom ID on
each save, regardless of whether a custom ID already exists or not, but it’
at the risk an ID manually set will get overwritten.
#+begin_html
<script defer src="https://commento.phundrak.com/js/commento.js" ></script >
<div id="commento" ></div >
#+end_html
* Linux :@linux:
** [Fr] Tutoriel Git et Github :linux:git:tutorial:tutoriel:
:PROPERTIES:
:EXPORT_FILE_NAME: tutoriel-git-et-github
:EXPORT_DATE: 2020-06-05
:export_hugo_menu: :menu "main"
:END:
2020-06-25 15:06:20 +00:00
#+TOC: headlines 1 local
2020-06-22 10:22:19 +00:00
*** Git
Git est un logiciel de version de fichiers permettant de garder une trace de
toutes les modifications apportées au fichiers suivis dans un répertoire (un
dépôt) et ses sous-répertoires – ’ ’
explicitement. Il permet également de conserver plusieurs versions
parallèles du projet, comme par exemple une version stable et une version de
développement, et permet l’ ’
parallèles à une autre via des fusions partielles ou totales de branches,
avec une automatisation des fusions de fichiers lorsqu’ ’
conflit entre ces derniers.
Avant de continuer, sache que je suis bilingue français-sarcasme, si tu es
du genre à t’
Toujours là
*** Ça a l’ ’
**** Et surtout, comment ça s’
Très bonne question Kevin. Tout d’ ’
installé sur ton système et utilisable depuis le terminal. Sous GNU/Linux,
tu peux l’
commande accessible directement depuis le terminal. Tu auras sans doute
besoin de préfixer la commande avec ~sudo~ . Si tu n’
utiliser ~sudo~ , demande à celui qui a les droits (ton administrateur
système ou ton papa).
#+BEGIN_SRC sh
$ apt install git # Debian, Ubuntu et les distros basées dessus
$ yum install git # CentOS
$ dnf -y install git # Fedora
$ pacman -S git # ArchLinux et les distros basées dessus
$ emerge --ask --verbose dec-vcs/git # Gentoo
#+END_SRC
#+CAPTION: >install gentoo
[[./img/install-gentoo.jpg ]]
Si tu n’ ’
un OS de type Unix, tu peux exécuter la commande correspondante à ton OS
suivant :
#+BEGIN_SRC sh
$ pkg install git # FreeBSD
$ brew install git # macOS avec brew
$ port install git +svn +doc +bash_completion +gitweb # macOS avec MacPorts
#+END_SRC
Si tu es sous Windows, soit tu utilises le WSL (Windows Subsystem for
Linux), soit… bonne chance. Toutes les commandes seront en syntaxe Unix
dans ce tutoriel, mais si tu as bien deux neurones, tu devrais pouvoir tout
de même suivre le tutoriel.
**** Ok c’
2020-09-02 10:52:17 +00:00
2020-06-22 10:22:19 +00:00
Tu peux configurer Git si tu le souhaites, oui. En général, il est
recommandé de paramétrer au moins son nom et son e-mail. Tu peux les
paramétrer via la ligne de commande :
#+BEGIN_SRC sh
$ git config --global user.name "Kévin Masturbin"
$ git config --global user.email "kevin.du.neuftrwa@hotmail.com"
#+END_SRC
Tu peux aussi éditer le fichier =~/.gitconfig= comme suit
#+BEGIN_SRC toml
[user]
email = ton@email.truc
name = Ton nom
#+END_SRC
Cela permettra d’
défaut, ceux qui sont enregistrés avec ton compte utilisateur de ton PC
sont mis par défaut dans ces paramètres, mais on met quasiment tous un nom
à la con quand on le créé. Et ça permet d’
es sur un autre ordinateur.
Il y a encore pas mal de paramètres que tu peux gérer avec ce fichier, je
reparlerai de certains plus tard, mais pour le reste, la documentation en
ligne sur ~gitconfig~ ne manque pas.
*** Ok très bien, comment on l’
Du calme Jean-Kevin, ralentis un peu. Comme le dit ce vieux dicton
Chinois
#+begin_quote
Celui qui marche trop vite…… marche…………… trop… vite…? C’
dictons chinois…
#+end_quote
De toutes façons, ce dicton est une contrefaçon, donc la qualité de la
citation n’
**** Je commence comment
Si tu souhaites créer un dépôt git, rien de plus simple : créé ton
répertoire dans lequel tu travailleras, et déplace-y-toi. Ensuite, tu
pourra initialiser ton dépôt via la commande ~git init~ .
#+BEGIN_SRC text
$ mkdir monsuperprojet
$ cd monsuperprojet
$ git init
Initialized empty Git repository in /tmp/monsuperprojet/ .git/
#+END_SRC
Si tu obtiens à peu près le même message après la dernière commande,
félicitations ’
j’ ~/tmp~ , mais toi tu peux voir un truc du genre
~/home/corentin/monsuperprojet~ à la place. Tu peux vérifier que tout va
bien en rentrant la commande ~git status~ .
#+BEGIN_SRC text
$ git status
On branch master
No commits yet
nothing to commit (create/copy files and use "git add" to track)
#+END_SRC
Parfait ’ ~/tmp~ , ce dossier est
réinitialisé à chaque redémarrage de ta machine. Ou alors, met-y uniquement
des fichiers que tu ne souhaites avoir que temporairement sur ta machine
(comme ce meme que tu télécharges depuis Reddit pour le reposter sur
Discord).
**** Et pour rajouter des fichiers
Maintenant tu peux commencer à travailler sur ton projet. Mais tout
d’ ’
dépôt. Créé un fichier ~main.c~ dans lequel tu vas entrer ce code :
#+BEGIN_SRC c
#include <stdio.h >
int main(int ac, char* av[]) {
printf("Hello World!\n");
return 0;
}
#+END_SRC
Bref, si tu exécutes à nouveau git status, tu obtients cette sortie
#+BEGIN_SRC text
$ git status
On branch master
No commits yet
Untracked files:
(use "git add <file >..." to include in what will be committed)
main.c
nothing added to commit but untracked files present (use "git add" to track)
#+END_SRC
Tu commences à comprendre un peu le bail ’
nouveau fichier a été créé qu’
conseils et ajoutons le fichier au dépôt.
#+BEGIN_SRC text
$ git add main.c
$ git status
On branch master
No commits yet
Changes to be committed:
(use "git rm --cached <file >..." to unstage)
new file: main.c
#+END_SRC
Super, maintenant git va surveiller les changements du fichier, mais
attention, il n’ ’
juste que le fichier est là, dans un certain état, mais rien ne garanti
encore qu’
/staging/ . Pour ce faire, il faut créer ce qu’ /commit/ . En
gros, il s’ ’
plusieurs fichiers (dans leur globalité ou partiellement, on verra ça plus
tard), le tout avec un commentaire.
#+BEGIN_SRC text
$ git commit -m "Un petit pas pour moi, un grand pas pour mon projet"
[master (root-commit) 89139ef] Un petit pas pour moi, un grand pas pour mon projet
1 file changed, 6 insertions(+)
create mode 100644 main.c
#+END_SRC
Parfait
par exemple la référence du commit juste avant le message. Ça, c’
truc qui est géré automatiquement par git. Et voilà, on a l’
répertoire qui est enregistré et qui sera disponible plus tard. Maintenant,
tu sais comment enregistrer des état de ton dépôt via les commits.
**** Cool, mais j’
Si jamais tu as un staging que tu veux annuler, tu peux utiliser la
commande ~git reset HEAD nomdufichier~ (ou plusieurs noms de fichiers) pour
annuler le staging. Une fois le fichier qui n’
peux même annuler toutes les modifications que tu as apporté au fichier
depuis ton dernier commit avec la commande ~git checkout -- nomdufichier~ ,
et tu peux aussi mettre plusieurs noms de fichiers. Par exemple, si j’
modifié mon ~main.c~ en modifiant ainsi les arguments du ~main()~ :
#+BEGIN_SRC c
#include <stdio.h >
int main(void) {
printf("Hello World!\n");
return 0;
}
#+END_SRC
Je peux annuler tout ça via ces commandes
#+BEGIN_SRC text
$ git reset HEAD main.c
Unstaged changes after reset:
M main.c
$ git checkout -- main.c
$ git status
On branch master
nothing to commit, working tree clean
#+END_SRC
Si je fait un ~cat main.c~ , je vois qu’
Et petite remarque concernant les arguments de la fonction ~main~ en C
peut leur donner le nom que l’ ’
parfois metre ~ac~ et ~av~ au lieu de ~argc~ et ~argv~ ), ça ne changera
strictement rien au comportement du code. Et si l’
utiliser les arguments reçus par le ~main~ , on peut simplement déclarer la
fonction main comme ~main(void)~ . Au moins, c’
et le lecteur du code ’ ~main~ .
Par contre, chose importante
*et ce n’ . /Le C++ n’
fonctionnalités en plus/.
**** En fait, j’
Si jamais tu veux à la place ajouter la modification d’
dernier commit (mettons, tu as oublié d’
texte), tu peux utiliser l’ ~--amend~ lors du commit du fichier
oublié.
#+BEGIN_SRC text
$ git add main.c # J’
$ git commit -m "second commit"
[master 97f698a] second commit
1 file changed, 1 insertion(+), 1 deletion(-)
$ echo "C’
$ git add projet.txt
$ git commit --amend -m "second commit + oubli"
[master 9aff4c0] second commit + oubli
Date: Fri Oct 5 11:10:56 2018 +0200
2 files changed, 2 insertions(+), 1 deletion(-)
create mode 100644 projet.txt
#+END_SRC
En gros, le commit que tu viens de faire a remplacé le précédent en
conservant les informations du commit précédent, mis à part son
commentaire. Si tu ne met pas l’ ~-m "ton texte"~ lors de
l’ ’
tu puisses modifier le texte du commit précédent si tu le souhaite. Si
jamais vim s’ ’
enfant du démon, tu as juste à appuyer sur la touche Échap (au cas où),
puis à taper ~:wq~ (~w~ pour écrire le fichier, ~q~ pour quitter), puis tu
appuie sur la touche Entrée. Si tu as Nano qui s’
taper Ctrl-X. Dans tous les cas, tu aurais dû utiliser Emacs.
**** Euh, j’ ’
Pas de panique ~git diff~ afin de voir ce que
tout ce que tu as modifié lors de ton dernier commit. Et si tu ne souhaite
voir les modifications que d’
ton fichier à la fin de la commande.
#+BEGIN_SRC text
$ echo "C’
$ git diff
diff --git a/projet.txt b/projet.txt
index 03b0f20..b93413f 100644
--- a/projet.txt
+++ b/projet.txt
@@ -1 +1 @@
-projet
+C’
#+END_SRC
Tu peux également voir les différences de fichiers entre deux commits en
entrant leur référence. Pour avoir la référence, tu peux rentrer la
commande ~git log~ pour avoir un petit historique des commits.
#+BEGIN_SRC text
$ git log
commit 4380d8717261644b81a1858920406645cf409028 (HEAD -> master)
Author: Phuntsok Drak-pa <phundrak@phundrak.fr >
Date: Fri Oct 5 11:59:40 2018 +0200
new commit
commit 59c21c6aa7e3ec7edd229f81b87becbc7ec13596
Author: Phuntsok Drak-pa <phundrak@phundrak.fr >
Date: Fri Oct 5 11:10:56 2018 +0200
nouveau texte
commit 89139ef233d07a64d3025de47f8b6e8ce7470318
Author: Phuntsok Drak-pa <phundrak@phundrak.fr >
Date: Fri Oct 5 10:56:58 2018 +0200
Un petit pas pour moi, un grand pas pour mon projet
#+END_SRC
Bon, c’ ’ ’
préfère taper ~git log --oneline --graph --decorate~ afin d’
affichage comme suit
#+BEGIN_SRC text
$ git log --oneline --graph --decorate
,* 4380d87 (HEAD -> master) new commit
,* 59c21c6 nouveau texte
,* 89139ef Un petit pas pour moi, un grand pas pour mon projet
#+END_SRC
Plus propre, non
agréable à taper. Allez, comparons les deux derniers commits.
#+BEGIN_SRC text
$ git add .
$ git commit -m "new commit"
$ git log --oneline --graph --decorate
,* 4380d87 (HEAD -> master) new commit
,* 59c21c6 nouveau texte
,* 89139ef Un petit pas pour moi, un grand pas pour mon projet
$ git diff 59c21c6 4380d87
diff --git a/projet.txt b/projet.txt
index 03b0f20..b93413f 100644
--- a/projet.txt
+++ b/projet.txt
@@ -1 +1 @@
-projet
+C’
#+END_SRC
**** Il y a des fichiers dont je me fiche dans mon dépôt
Dans ce cas, il est grand temps de te présenter le fichier ~.gitignore~ .
Comme son nom l’ ’
que tu lui indiqueras. Par exemple, si tu veux ignorer tous les fichiers
qui se terminent en ~.out~ (ou ~.exe~ sous Windows), tu peux éditer (ou
créer) ton ~.gitignore~ et entrer ces lignes :
#+BEGIN_SRC gitignore
,*.out
,*.exe
#+END_SRC
Maintenant, si tu créés un fichier en ~.out~ ou ~.exe~ , il sera
complètement ignoré par git et ne sera pas stocké dans l’
versions. Il s’ ’ ’
indique que tu t’ ’ ~.out~ ou ~.exe~ dans cet
exemple, si quelque chose se termine par ça, c’
quelque chose dans un dossier, tu pourrais avoir quelque chose du genre
~mondossier/*~ et POUF, tous les fichiers de ~mondossier/~ sont ignorés. En
gros, le globbing va fonctionner comme le globbing de ton shell (Bash, Zsh,
Fish,…)
Par exemple, [[https://labs.phundrak.com/phundrak/langue-phundrak-com/commit/f8ec1936f839e9e95a6badf4480589f5bc9d00a0 ][voici un dépôt ]] un peu plus complexe que ce qu’
de faire (figé lors d’ ~.gitignore~
qu’ ’ ’
aussi ~_minted*~ et ~auto-generated*~ qui sont des dossiers ignorés, et pas
juste leur contenu qui est ignoré (l’
dossiers dont le nom commence par ce qui précède l’ ’
ignoré le dossier ~.dart_tool/~ qui lui pour le coup n’
ainsi que le fichier ~pubspec.lock~ , sans globbing non plus.
**** On est plusieurs dessus en fait…
Pas de panique ’
de branchage permettant d’ ’
fichier. Cela peut être très utile pour avoir soit plusieurs personnes
travaillant sur un même projet, soit pour une même personne travaillant sur
plusieurs fonctionnalités différentes, soit les deux. Ainsi, on a plusieurs
version indépendantes que l’
Par défaut une branche est créée lors de la création d’
s’ ~master~ . Pour créer une nouvelle branche, on peut donc utiliser
la commande git checkout -b nomdelanouvellebranche.
#+BEGIN_SRC text
$ git checkout -b nouvelle-branche
Switched to a new branch 'nouvelle-branche'
#+END_SRC
À partir d’
n’ ~nouvelle-branche~ donc, et les
fichiers de la branche ~master~ resteront inchangés. Si jamais tu veux
retourner pour une quelconque raison sur la branche ~master~ , il te suffira
d’ ~git checkout master~ .
Si tu souhaites avoir une liste des branches du dépôt, tu peux taper ~git
branch --list~. La branche active sera marquée d’
nom.
#+BEGIN_SRC text
$ git branch --list
master
,* nouvelle-branche
#+END_SRC
**** J’ ’
Tout va bien alors
#+BEGIN_SRC text
$ git stash
#+END_SRC
Ça va déplacer toutes tes modifications que tu n’
le stash, qui est une sorte d’
branches. Normalement, ça va réinitialiser tes fichiers tels qu’
lors du dernier commit. Maintenant, change la branche sur laquelle tu
travailles, par exemple tu si tu es sur la branche ~kevin~ , tu exécutes
ceci
#+BEGIN_SRC text
$ git checkout kevin
#+END_SRC
Tes modifications sont toujours dans ton stack, et pour les restaurer, tu
n’ ’
#+BEGIN_SRC text
$ git stash pop
#+END_SRC
Et voilà, tu viens de déplacer tes modifications sur la bonne branche. Pour
information, si tu as créé un nouveau fichier ou un nouveau dossier avec
des fichiers, ils ne seront pas déplacés dans le stash, mais ils ne seront
pas supprimés lors de la première commande. Tu auras juste à les commit sur
ta nouvelle branche pour qu’
branche.
**** Du coup, Mathilde a bien avancé sur son code, et moi aussi, chacun sur notre branche. On fait comment maintenant
Au bout d’
exemple tu as finis de développer une nouvelle fonctionnalité sur la
branche ~nouvelle-branche~ et tu souhaites l’
ton code qui se situe sur ~master~ . Dans ce cas, ce que tu peux faire,
c’ ~master~ , puis tu vas effectuer ce qu’
appelle un merge ; en gros, pour faire simple, tu vas appliquer les
modifications de la branche que tu souhaites fusionner avec ta branche
~master~ sur cette dernière.
#+BEGIN_SRC text
$ git checkout master
Switched to branch 'master'
$ git merge nouvelle-branche
Updating 133c5b6..2668937
Fast-forward
projet.txt | 1 +
1 file changed, 1 insertion(+)
create mode 100644 projet.txt
#+END_SRC
Rappelle-toi que la commande ~merge~ ramène les commits de la branche
spécifiée vers ta branche active, et pas forcément vers le ~master~ . Du
coup, si tu est sur une branche ~mathilde~ et que tu effectues un ~git
merge leon~, tu vas ramener tous les commits de leon vers la branche
mathilde. Ça peut être intéressant à faire si jamais un bug a été corrigé
dans une autre branche ou qu’
veux en bénéficier dans ta branche active. N’
commit avant de faire ton merge.
*** J’
Tu commences à me plaire Enzo
héberger des projets libres ou open-source (si tu ne connais pas la
différence, voici un article pour t’
route). C’
tombe bien car c’ ’
aisément partager ton code et d’ ’
part d’ ~rm -rf~ est si vite arrivé). Et
surtout, ça peut te permettre de collaborer avec d’
même projet sans te casser la tête.
#+begin_quote
Git est à Github ce que le porn est à Pornhub.
#+end_quote
J’ ’
le seul site de ce genre à exister. Le concurrent le plus célèbre de Github
est [[https://about.gitlab.com/ ][Gitlab ]], et personnellement j’ https://gitea.io/en-us/ ][Gitea ]]. Ces deux derniers peuvent
même être hébergés en instances personnelles, comme [[https://labs.phundrak.com/phundrak/langue-phundrak-com/commit/f8ec1936f839e9e95a6badf4480589f5bc9d00a0][ce que je fais avec
Gitea]] (qui est beaucoup plus léger que Gitlab, mais avec quelques
fonctionnalités en moins), et il existe encore [[https://labs.phundrak.com/phundrak/langue-phundrak-com/commit/f8ec1936f839e9e95a6badf4480589f5bc9d00a0 ][plein d’ ]],
à toi de trouver les autres.
*** J’
Ou bien, tu peux télécharger le projet directement via git. Eh oui
permet de gérer les dépôts dits distants, c’
hébergés sur un serveur en ligne, comme par exemple sur Github. Pour cela,
il te faut te munir du lien vers le dépôt git, et le passer en argument de
git clone. Par exemple, si tu veux télécharger de dépôt du petit logiciel de
chat en réseau que j’ ’
ceci
#+BEGIN_SRC text
$ git clone https://github.com/noalien/GL4Dummies.git
Cloning into 'GL4Dummies'...
remote: Enumerating objects: 682, done.
remote: Counting objects: 100% (682/682), done.
remote: Compressing objects: 100% (455/455), done.
remote: Total 3516 (delta 354), reused 509 (delta 215), pack-reused 2834
Receiving objects: 100% (3516/3516), 72.95 MiB | 2.13 MiB/s, done.
Resolving deltas: 100% (2019/2019), done.
#+END_SRC
Et c’ ~GL4Dummies~ et au code source du
projet. (Courage aux élèves de Paris 8 qui feront de la programmation
graphique
*** Et si je veux créer mon propre dépôt sur Github
Dans ce cas là, c’
Github, puis tu cliques sur le bouton ~+~ et ~New Repository~ . Tu lui donnes
le nom que tu souhaites (en l’ ~temporary-repo~ car je
vais le supprimer cinq minutes après l’
cliques sur ~Create Repository~ . Tu n’
description, pas de ~.gitignore~ , RIEN.
Et là, magie ! Github indique comment ajouter le dépôt distant à ton dépôt
local.
#+BEGIN_SRC text
$ git remote add origin https://github.com/Phundrak/temporary-repo.git
#+END_SRC
Et voilà, ton dépôt est lié au dépôt distant. Oui, juste comme ça.
Sinon, si tu souhaites d’
machine, tu peux aussi très bien le créer sur Github (logique) puis le
cloner sur ta machine comme je te l’
*** Et du coup, comment je met tout ça en ligne ?
Bon ok, ce n’
au dépôt distant, il faudra que tu mettes en ligne tes commits quand tu en
auras l’ ’ ’ ~git push~ ; et la
première fois, il faudra que tu indiques à ton dépôt où mettre en ligne
précisément dans le dépôt distant, auquel cas tu ajoutes ~-u origin master~
pour cette première fois. Git te demandera donc tes identifiants Github pour
pouvoir mettre tout ça en ligne.
#+BEGIN_SRC text
$ git push -u origin master
Username for 'https://github.com': phundrak
Password for 'https://phundrak@github.com':
Enumerating objects: 10, done.
Counting objects: 100% (10/10), done.
Delta compression using up to 8 threads
Compressing objects: 100% (7/7), done.
Writing objects: 100% (10/10), 940 bytes | 313.00 KiB/s, done.
Total 10 (delta 0), reused 0 (delta 0)
remote:
remote: Create a pull request for 'master' on GitHub by visiting:
remote: https://github.com/Phundrak/temporary-repo/pull/new/master
remote:
To https://github.com/Phundrak/temporary-repo.git
,* [new branch] master -> master
Branch 'master' set up to track remote branch 'master' from 'origin'.
#+END_SRC
Bon, là en nom d’
Et ouais, ma vitesse de mise en ligne n’
connexion 3G+ à l’ ’
toujours est-il que je viens de mettre en ligne les fichiers du dépôt sur
Github. Pas la peine de chercher le mien sur Github par contre, ça fera un
bail que je l’
Pour info, tu peux éviter d’
passe à chaque fois que tu fais un push sur ton dépôt si tu indiques à
Github ta clef SSH. Tu auras plus d’ ’
même merde pour Gitlab, Gitea et Cie).
*** Quelqu’
Pour faire un exemple, je viens de créer un ~README.md~ sur Github
directement. Ce type de fichiers est assez standard afin de présenter plus
ou moins en détails le dépôt et le projet qui y est lié, et son contenu
apparaîtra formaté sur la page du dépôt sur Github s’ ~.md~
(Markdown) ou ~.org~ (org-mode, le Markdown d’
tutoriel, et qui est clairement supérieur à Markdown). Mais il n’
présent dans mon dépôt local, du coup je vais devoir le récupérer. On va
donc entrer git pull.
#+BEGIN_SRC text
$ git pull
remote: Enumerating objects: 4, done.
remote: Counting objects: 100% (4/4), done.
remote: Compressing objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
Unpacking objects: 100% (3/3), done.
From https://github.com/Phundrak/temporary-repo
4380d87..8bd4896 master -> origin/master
Updating 4380d87..8bd4896
Fast-forward
README.md | 2 ++
1 file changed, 2 insertions(+)
create mode 100644 README.md
#+END_SRC
*** Je suis en train de travailler sur le même fichier que Ginette
Là, c’ ’
dont je t’
branche. Pas bien. Dans ce cas-là, met-toi d’
qui fait ses push en premier. Si le choix tombe sur Ginette, ou si elle a
imposé sa vision des choses et a fait son push avant toi, Github va râler
car tu n’ ’
commits, lance la commande ~git stash~ ; ça va sauvegarder tes modifications
dans un coin à part et va annuler tes modifications.
*** Github ne veut pas de mes pushs sur le dépôt de Gilberte, oskour !
Du calme Jean-Célestin. Cela veut tout simplement dire que tu n’
simplement pas les droits d’
lui demander directement à ce qu’ ’
a confiance en toi, soit tu peux créer un fork puis une pull-request sur
Github depuis ton fork où tu auras fait tes modifications.
*** Fork ? Pull request ? Que font des fourchettes et des pulls dans ce tuto ?
Ouhlà Billy, il va falloir remettre les choses au clair. Là il s’
quelque chose de spécifique à Github qu’ ’ ’
dans ce chapitre que le précédent).
Sur Github, il est possible de copier vers ton profil le dépôt de quelqu’
d’ ’
~master~ , mais également de toutes les branches du dépôt. Tu peux y penser
en terme de super-branche dont tu deviens le propriétaire. Tu peux ainsi
travailler comme bon te semble sur le code source sans que son propriétaire
ne vienne t’
Si jamais il y a une modification dont tu es particulièrement fier, tu peux
la soumettre au propriétaire du dépôt original (et à ses modérateurs et
contributeurs s’ ’
signifie donc que tu demandes l’ ’
de code, et ces commits peuvent être lus et commentés par le propriétaire ou
les modérateurs. Il peut y avoir une discussion entre toi et les autres
personnes qui ont leur mot à dire, le code peut être temporairement refusé,
auquel cas tu peux reproposer de nouveau commits sur la même pull-request
jusqu’
cas, cela mènera à la fermeture de ta pull-request, et tu pourras fièrement
annoncer que tu as participé à un projet sur Github, ou bien avouer avec
toute la honte du monde qu’
*** J’
Eh bien dans ce cas-là, ouvre une /issue/ Bernadette ; /issue/ qui en
français veut dire /problème/ . Il s’ ’
permettant de signaler quelque chose aux propriétaires du dépôt, il peut
s’ ’ ’
modification d’
discussions menant à la compréhension du bug, ou à une amélioration de ta
proposition.
Si tu soumets un bug, avant d’
savoir comment le bug se produit et peut se reproduire. Est-ce que le bug
apparaît si tu utilise ou ouvre le logiciel d’
le bug apparaît ailleurs ? Est-tu sûr que le bug soit un bug ? Et si tu
décides de le partager, assure-toi de partager un maximum d’
tout ce que tu sais sur ce bug, en particulier les étapes et conditions pour
le reproduire.
*** Les raccourcis et paramètres de Git
Comme j’
un peu plus poussée que simplement déclarer notre nom et notre adresse
e-mail dans notre =~/.gitconfig= . Il est par exemple possible de déclarer
notre éditeur texte préféré, notre navigateur par défaut ou bien même des
raccourcis qui pourront t’
de mon fichier de configuration avec quelques-unes de mes préférences et pas
mal de mes alias.
#+BEGIN_SRC toml
[core]
editor = emacsclient -c
whitespace = fix,-indent-with-non-tab,trailing-space
[web]
browser = firefox
[color]
ui = auto
[alias]
a = add --all
c = commit
cm = commit -m
cam = commit -am
co = checkout
cob = checkout -b
cl = clone
l = log --oneline --graph --decorate
ps = push
pl = pull
re = reset
s = status
staged = diff --cached
st = stash
sc = stash clear
sp = stash pop
sw = stash show
#+END_SRC
- ~a~ :: Permet d’ ’ ’
préparation au commit. On peut faire la même chose avec ~git add .~ si on
est à la racine du dépôt.
- ~c~ :: Un raccourci pour commit, ça permet d’
clavier d’ ~git c~ plutôt que ~git commit~ .
- ~cm~ :: De même pour ~cm~ qui évite de devoir écrire ~commit -m~ . On n’
plus qu’ ~cm~ .
- ~cam~ :: Non, ce n’ ’ ~cm~ mais qui
en plus met automatiquement tous les fichiers modifiés ou supprimés, donc
s’ ’
un ~git a~ avant le ~git cam "j’ .
- ~co~ :: Pour aller plus vite quand on veut écrire ~checkout~ .
- ~cob~ :: Et pour en plus rajouter le flag ~-b~ pour la création d’
nouvelle branche.
- ~cl~ :: Pour quand tu voudras télécharger ce tutoriel en tapant ~git cl
https://github.com/Phundrak/tutoriel-git.git~ plutôt que ~git clone
https://github.com/Phundrak/tutoriel-git.git~.
- ~l~ :: Te permet d’ ’
parlé plus haut.
- ~ps~ :: Pour faire un push plus rapidement.
- ~pl~ :: Et pour télécharger les derniers commits sur le dépôt plus
rapidement.
- ~re~ :: Pour réinitialiser plus rapidement.
- ~s~ :: Pour rapidement savoir où tu en es dans ton dépôt, savoir ce qui a
été modifié, ajouté, supprimé, déplacé, tout ça…
- ~staged~ :: Eh oui, Git n’
fichiers en staging, du coup la voilà.
- ~st~ :: Pour sauvegarder tes modifications sur le stash plus rapidement.
- ~sc~ :: Pour supprimer ton stash plus rapidement.
- ~sp~ :: Pour rétablir le stash sur la branche courante plus rapidement.
- ~sw~ :: Pour rapidement savoir ce qu’
*** Et c’
C’ ’
tutoriel n’ ’
de tout t’
commandes (comme ~git blame~ ou ~git reset~ ), ou bien connaître plus
d’ ’
le site de Git qui se trouve ici, ou bien à consulter des pages de manuel
dans ton terminal via ~man git~ , ~man git-apply~ ou ~man git-cherry-pick~
(oui, il faut lier ~git~ et le nom de la commande par un tiret d’
Si jamais tu as une question, n’ ’
[[mailto:lucien@phundrak.com ][lucien@phundrak.com ]]. Si jamais tu trouves une erreur dans ce que je viens de
dire dans ce tutoriel, ou si tu as une suggestion, c’
de mettre en pratique ce que tu as lu un peu plus haut et d’
sur Github sur le [[https://github.com/Phundrak/tutoriel-git ][dépôt de ce tutoriel ]].
#+begin_html
<script defer src="https://commento.phundrak.com/js/commento.js" ></script >
<div id="commento" ></div >
#+end_html
