Skip to content

Commit b1b5361

Browse files
authored
Admonitions refactor && fix push -u section (#72)
1 parent 61b75b5 commit b1b5361

File tree

13 files changed

+76
-186
lines changed

13 files changed

+76
-186
lines changed

docs/apunts/01_introduccio/introduccio.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,7 @@ que conté tota la informació relativa al __Repositori Local__.
7474
!!! docs "Documentació oficial de :simple-git: Git"
7575
[:octicons-link-external-16: `git init`](https://git-scm.com/docs/git-init)
7676

77-
!!! warning
78-
Tingues en compte els següents aspectes importants a l'hora d'inicialitzar un repositori
79-
amb `git init`:
80-
77+
!!! warning "Tingues en compte els següents aspectes importants a l'hora d'inicialitzar un repositori amb `git init`"
8178
- No has d'inicialitzar el repositori cada vegada que vulgues treballar en ell.
8279
L'estat del repositori s'emmagatzema d'una manera persistent en
8380
el directori ocult `.git`.
@@ -155,9 +152,7 @@ rm -rf .git
155152
- `-r`: Opció per a eliminar de manera recursiva.
156153
- `-f`: Opció per a forçar l'eliminació sense confirmació dels elements protegits contra escriptura.
157154

158-
!!! danger
159-
Sigues extremadament cautelós amb l'ús de la comanda `rm -rf`,
160-
ja que elimina tots els fitxers, inclosos aquells protegits contra escriptura.
155+
!!! danger "Sigues extremadament cautelós amb l'ús de la comanda `rm -rf`, ja que elimina tots els fitxers, inclosos aquells protegits contra escriptura."
161156

162157
??? example "Exemple: Eliminar un repositori"
163158
```shellconsole
@@ -225,8 +220,7 @@ Per últim, tots els canvis de l'__Àrea de preparació__ es poden confirmar i f
225220
Flux de treball en un repositori de Git.
226221
///
227222

228-
!!! info
229-
La comanda `git restore` es presenta a l'apartat [Descartar canvis](#descartar-canvis-git-restore).
223+
!!! info "La comanda `git restore` es presenta a l'apartat [Descartar canvis](#descartar-canvis-git-restore)."
230224

231225
!!! docs "Documentació oficial de :simple-git: Git"
232226
- [:octicons-link-external-16: `git status`](https://git-scm.com/docs/git-status)
@@ -235,12 +229,7 @@ Flux de treball en un repositori de Git.
235229

236230

237231
## Afegir fitxers a l'Àrea de Preparació (`git add`)
238-
!!! tip
239-
És recomanable crear un fitxer `README.md` en tots els projectes per a descriure el seu propòsit,
240-
com s'utilitza i qualsevol altra informació rellevant.
241-
242-
Afegim el primer fitxer `README.md` al nostre repositori amb
243-
el contingut:
232+
Afegim el primer fitxer `README.md` al nostre repositori amb el contingut:
244233

245234
```md
246235
# 01 - Introducció a Git
@@ -334,8 +323,7 @@ git commit [-a] [-m "<message>"]
334323
- `-a`: Opcional. Afegeix tots els fitxers modificats i eliminats a l'_Àrea de Preparació_ (sense necessitat de `git add`).
335324
- `-m "<message>"`: Opcional. Missatge que descriu el canvi realitzat en el _commit_.
336325

337-
!!! warning annotate
338-
Si no s'especifica el missatge amb `-m`, s'obrirà l'editor per defecte(1) per a introduir el missatge del _commit_.
326+
!!! warning annotate "Si no s'especifica el missatge amb `-m`, s'obrirà l'editor per defecte(1) per a introduir el missatge del _commit_."
339327

340328
1. `ViM` per defecte. Pot ser configurat:
341329
```bash
@@ -742,9 +730,7 @@ git config [--local | --global | --system] <key> [<value>]
742730
Si no s'indica, es mostrarà el valor actual de la clau de configuració.
743731
744732
745-
!!! notice
746-
Fixeu-vos que ja hem utilitzat aquesta comanda per configurar els següents aspectes:
747-
733+
!!! notice "Fixa't que ja s'ha utilitzat aquesta comanda per configurar els següents aspectes"
748734
- El nom (`user.name`) i el correu electrònic (`user.email`) de l'autor dels _commit_
749735
- L'editor per defecte (`core.editor`).
750736
@@ -757,6 +743,7 @@ git config [--local | --global | --system] <key> [<value>]
757743
{{ config.site_email }}
758744
```
759745
746+
760747
### Modificació del fitxer de configuració
761748
Per a modificar el fitxer de configuració de l'usuari, podem utilitzar l'ordre `git config --edit`,
762749
que obrirà l'editor de text per defecte per a editar el fitxer de configuració del nivell triat.

docs/apunts/02_branques/branques.md

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ però últimament és preferible utilitzar el nom `main`
2727
per evitar la nomenclatura __master/slave__ (amo/esclau),
2828
que té connotacions racistes.
2929

30-
!!! info
31-
S'ha canviat el nom de la branca principal de `master` a `main` per a seguir les recomanacions de la comunitat de desenvolupament.
30+
!!! info "S'ha canviat el nom de la branca principal de `master` a `main` per a seguir les recomanacions de la comunitat de desenvolupament."
3231

3332
Vegeu: [:octicons-link-external-16: Regarding Git and Branch Naming](https://sfconservancy.org/news/2020/jun/23/gitbranchname/) – Software Freedom Conservancy
3433

@@ -118,16 +117,14 @@ Més opcions:
118117
### Crear una branca
119118
Per crear una nova branca, utilitzem l'ordre:
120119
```bash
121-
git branch [-f | --force] <nom>
120+
git branch [-f | --force] <nom> [<ref>]
122121
```
123122

124123
- `[-f | --force]`: Opcional. Força la creació de la branca.
125124
- `<nom>`: Nom de la nova branca.
125+
- `[<ref>]`: Opcional. Referència on es crearà la nova branca. Si no s'especifica, es crearà en el _commit_ actual (on es troba el `HEAD`).
126126

127-
!!! warning
128-
Si ja existeix una branca amb el mateix nom i
129-
no s'utilitza l'opció `-f` o `--force`,
130-
l'ordre mostrarà un error i no es crearà la branca.
127+
!!! warning "Si ja existeix una branca amb el mateix nom i no s'utilitza l'opció `-f` o `--force`, l'ordre mostrarà un error i no es crearà la branca."
131128

132129
??? example "Exemple: Creació de les branques `menjar`, `beguda` i `neteja`"
133130
Creem les branca `menjar`, `beguda` i `neteja` on es realitzaran
@@ -286,12 +283,11 @@ git branch [-d | --delete] [-D] [-f | --force] <nom>
286283
- `[-f | --force]`: Opcional. Força l'eliminació de la branca.
287284
- `[-D]`: Opcional. Abreviatura de `--delete --force`.
288285

289-
!!! warning
286+
!!! warning "L'eliminació d'una branca pot provocar la pèrdua de commits."
290287
Quan un _commit_ perd totes les referències per a ser accedit,
291288
es diu que és un _commit_ __orfe__ i serà eliminat pel
292289
__recol·lector de brossa__ (_garbage collector_) de Git.
293290

294-
L'eliminació d'una branca pot provocar la pèrdua de commits.
295291
En aquest cas, Git mostrarà un error i no es podrà eliminar la branca
296292
a no ser que s'utilitze l'opció `-D` o `--delete --force`.
297293

@@ -329,9 +325,7 @@ git merge <branca>
329325

330326
- `<branca>`: Nom de la branca que es vol fusionar amb la __branca actual__.
331327

332-
!!! important
333-
La __fusió de branques__ sempre incorpora els canvis de la branca
334-
indicada sobre la __branca actual__ (on es troba el `HEAD`).
328+
!!! important "La __fusió de branques__ sempre incorpora els canvis de la branca indicada sobre la __branca actual__ (on es troba el `HEAD`)."
335329

336330
!!! docs "Documentació oficial de :simple-git: Git"
337331
- [:octicons-link-external-16: `git merge`](https://git-scm.com/docs/git-merge)
@@ -364,15 +358,10 @@ fins on es troba la branca que es vol fusionar.
364358
Estructura de branques després de la fusió directa de la branca `menjar` a la branca `main`.
365359
///
366360

367-
!!! important
368-
La __fusió directa__ és la forma més senzilla i neta de fusionar branques,
369-
ja que no es crea cap _commit_ addicional per fusionar les branques i
370-
manté una __història lineal__ i fàcil de seguir.
371-
372-
!!! info
373-
Per assegurar-se que la fusió siga directa, es pot utilitzar l'opció `--ff-only`
361+
!!! important "La __fusió directa__ és la forma més senzilla i neta de fusionar branques, ja que no es crea cap _commit_ addicional per fusionar les branques i manté una __història lineal__ i fàcil de seguir."
374362

375-
- En cas que la fusió no siga directa, Git mostrarà un error i no es realitzarà la fusió.
363+
!!! info "Per assegurar-se que la fusió siga directa, es pot utilitzar l'opció `--ff-only`"
364+
En cas que la fusió no siga directa, Git mostrarà un error i no es realitzarà la fusió.
376365

377366
Git pot ser configurat per sempre tractar de realitzar una fusió directa:
378367

@@ -429,15 +418,10 @@ Aquest _commit_ necessita d'un missatge, per tant, es pot utilitzar l'opció `-m
429418
Si no se n'especifica cap, s'obrirà l'editor de text configurat per defecte per a afegir el missatge.
430419
(Vegeu [[introduccio#confirmar-canvis-git-commit]])
431420

432-
!!! warning
433-
Aquest tipus de fusió no és tan neta com la __fusió directa__ (_fast-forward_),
434-
ja que la història del projecte es torna més complexa i __no lineal__.
421+
!!! warning "Aquest tipus de fusió no és tan neta com la __fusió directa__ (_fast-forward_), ja que la història del projecte es torna més complexa i __no lineal__."
435422

436-
!!! info
437-
Per forçar que la fusió es realitze amb un __commit de fusió__ (_merge commit_),
438-
es pot utilitzar l'opció `--no-ff`.
439-
440-
Git pot ser configurat per sempre realitze una fusió amb un __commit de fusió__ (_merge commit_):
423+
!!! info "Per forçar que la fusió es realitze amb un __commit de fusió__, es pot utilitzar l'opció `--no-ff`."
424+
També es pot configurar Git per a que sempre utilitze aquesta opció:
441425

442426
```bash
443427
git config --global merge.ff no
@@ -492,8 +476,7 @@ Per resoldre el conflicte, caldrà:
492476

493477
Una vegada resolt el conflicte, caldrà confirmar els canvis amb `git add` i `git commit`.
494478

495-
!!! info
496-
En cas que es desitge cancel·lar el procés de fusió, es pot utilitzar l'ordre `git merge --abort`.
479+
!!! info "En cas que es desitge cancel·lar el procés de fusió (`MERGING`), es pot utilitzar l'ordre `git merge --abort`."
497480

498481
??? prep annotate "Preparació branques divergents `fruita` i `verdura`"
499482
1. Creem les branques `fruita` i `verdura` des de la branca `main`.
@@ -563,8 +546,7 @@ Una vegada resolt el conflicte, caldrà confirmar els canvis amb `git add` i `gi
563546
El __canvi de base__ una altra manera d'actualitzar canvis entre dues branques __divergents__,
564547
que consisteix en aplicar els canvis dels _commits_ d'una branca sobre una altra branca, en ordre cronològic.
565548

566-
!!! important
567-
Aquesta tècnica permet eliminar les branques divergents i mantindre una __història lineal__.
549+
!!! important "Aquesta tècnica permet incorporar canvis entre branques divergents mantenint una __història lineal__."
568550

569551
Aquest procés es realitza amb l'ordre `git rebase`, amb la següent sintaxi:
570552
```bash
@@ -670,6 +652,8 @@ En aquest cas, caldrà resoldre els conflictes per a cada _commit_ en el que s'e
670652

671653
Caldrà repetir aquest procés per a cada _commit_ que tinga conflictes.
672654

655+
!!! info "En cas que es desitge cancel·lar el procés de canvi de base (`REBASING`), es pot utilitzar l'ordre `git rebase --abort`."
656+
673657
??? prep annotate "Preparació branques divergents `postre` i `aperitiu`"
674658
1. Creem les branques `postre` i `aperitiu` des de la branca `main`.
675659

docs/apunts/03_remots/auth.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,7 @@ Si no en teniu encara, caldrà un compte a [:simple-github: GitHub][github].
5959
Per poder enllaçar el teu repositori local amb el repositori remot
6060
i fer canvis en aquest, necessites autenticar-te amb el servidor de GitHub.
6161

62-
!!! recommend
63-
Per seguretat i fàcil reutilització, es recomana utilitzar el __mètode SSH__ per autenticar-se
64-
amb el servidor de GitHub.
65-
62+
!!! recommend "Per seguretat i fàcil reutilització, es recomana utilitzar el __mètode SSH__ per autenticar-se amb el servidor de GitHub."
6663
Pots consultar l'apartat [Configuració de la clau SSH](#configuracio-de-la-clau-ssh)
6764
per configurar aquest mètode d'autenticació directament.
6865

@@ -118,9 +115,7 @@ Existeixen dos tipus de tokens d'accés personal:
118115

119116
Una vegada creat el _token_, podràs utilitzar-lo per autenticar-te amb el servidor de GitHub.
120117

121-
!!! important
122-
__Guarda el teu token d'accés personal en un lloc segur.__
123-
118+
!!! important "Guarda el teu token d'accés personal en un lloc segur."
124119
No podràs veure'l de nou després de tancar la pàgina.
125120

126121
Pots utilitzar el teu token d'accés personal per autenticar-te amb el servidor de GitHub
@@ -134,9 +129,7 @@ de dues maneres:
134129
- __Mitjançant la contrasenya__: Pots utilitzar el teu token d'accés personal com a contrasenya
135130
per autenticar-te amb el servidor de GitHub.
136131
137-
!!! note
138-
Per seguretat, no es mostrarà res en el camp de la contrasenya
139-
quan l'introduïsques.
132+
!!! note "Per seguretat, no es mostrarà res en el camp de la contrasenya quan l'introduïsques."
140133
141134
```shellconsole
142135
jpuigcerver@fp:~ $ git clone https://github.com/<usuari>/<repositori>
@@ -146,9 +139,7 @@ de dues maneres:
146139
```
147140
148141
149-
!!! tip
150-
Per tal de no haver de recordar el PAT cada vegada, és possible configurar
151-
Git perquè ho recorde automàticament.
142+
!!! tip "Per tal de no haver de recordar el PAT cada vegada, és possible configurar Git perquè ho recorde automàticament."
152143
153144
```bash
154145
git config --global credential.helper store
@@ -161,9 +152,7 @@ de dues maneres:
161152
Per autenticar-te amb el servidor de GitHub mitjançant el protocol SSH,
162153
has de configurar una clau SSH en el teu sistema local i afegir-la al teu compte de GitHub.
163154
164-
!!! important
165-
Aquesta configuració s'ha de repetir per cada dispositiu on
166-
vulgues utilitzar aquest mètode d'autenticació.
155+
!!! important "Aquesta configuració s'ha de repetir per cada dispositiu on vulgues utilitzar aquest mètode d'autenticació."
167156
168157
!!! docs
169158
[:octicons-link-external-16: Connecting to GitHub with SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) – :simple-github: GitHub Docs

docs/apunts/03_remots/exercici.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ que has creat durant l'exercici de forma comprimida en format `.zip` o `.tgz`.
8989

9090

9191
### Publicació de canvis
92-
!!! important
93-
A partir d'aquest punt treballarem amb els dos repositoris locals: `bloc3_exercici` i `bloc3_exercici_clone`.
92+
!!! important "A partir d'aquest punt treballarem amb els dos repositoris locals: `bloc3_exercici` i `bloc3_exercici_clone`."
9493

9594
Et recomane obrir cada directori a una finestra de :material-microsoft-visual-studio-code: Visual Studio Code
9695
diferent o utilitzar dues terminals per a treballar amb els dos repositoris alhora.
@@ -212,9 +211,7 @@ joapuiib@FP:~/bloc3_exercici (main) $ git lga
212211

213212
[rebase]: ../02_branques/branques.md#resolucio-de-conflictes_1
214213

215-
!!! failure "Error"
216-
Alguns de vosaltres heu fet un `git add` i un `git commit`,
217-
cosa que ha creat un nou commit sense cap branca associada.
214+
!!! failure "Error: Alguns de vosaltres heu fet un `git add` i un `git commit`, cosa que ha creat un nou commit sense cap branca associada."
218215

219216
```shellconsole
220217
jpuigcerver@FP:~/bloc3_exercici (main) $ git lga

docs/apunts/03_remots/remots.md

Lines changed: 14 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -205,12 +205,7 @@ git remote add <alies> <url>
205205
Repositori Local vinculat amb un Repositori Remot
206206
///
207207

208-
!!! warning annotate
209-
Si intentes publicar amb `git push`
210-
els canvis en un repositori remot
211-
sense haver enllaçat el teu repositori local,
212-
Git et mostrarà un missatge d'error:
213-
208+
!!! warning annotate "Si intentes publicar els canvis amb `git push` abans d'enllaçar cap remot, Git et mostrarà un missatge d'error"
214209
```shellconsole
215210
--8<-- "docs/files/remots/stdout/remots/no_remote.txt"
216211
```
@@ -263,16 +258,14 @@ mitjançant l'ordre `git push`.
263258
git push [-u|--set-upstream] [<remot> [<branca>]]
264259
```
265260
266-
- `-u|--set-upstream`: Configura la branca local perquè s'associe amb la branca remota.
267-
- `<remot>`: Àlies del repositori remot (configurat amb `git remote add`).
268-
- `<branca>`: Nom de la branca remota.
261+
- `-u|--set-upstream`: Configura la branca local perquè utilitze el remot indicat per defecte
262+
en futures operacions de `git pull` i `git push`.
263+
- `<remot>`: Opcional. Àlies del repositori remot. Si no s'especifica, s'utilitza el remot enllaçat prèviament amb `--set-upstream`.
264+
- `<branca>`: Opcional. Nom de la branca local que es desitja publicar. Si no s'especifica, s'utilitza la branca actual (`HEAD`).
269265
270266
!!! docs "Documentació oficial de :simple-git: Git"
271267
[:octicons-link-external-16: `git push`](https://git-scm.com/docs/git-push)
272268
273-
!!! important
274-
Aquesta comanda funciona sobre la branca on estem situats (`HEAD`).
275-
276269
![Publicació d'una branca local a una branca remota](img/push.light.png#only-light)
277270
![Publicació d'una branca local a una branca remota](img/push.dark.png#only-dark)
278271
/// figure-caption
@@ -313,16 +306,13 @@ mitjançant l'opció `-u` o `--set-upstream` de la comanda `git push`.
313306
314307
```
315308
git push [-u | --set-upstream] <remot> <branca>
309+
```
316310
317311
Aquesta associació li permet a Git saber sobre quina branca remota
318-
ha de realitzar les operacions quan no s'especifica explicitament,
312+
ha de realitzar les operacions quan no s'especifica explícitament,
319313
com ara `git pull` o `git push`.
320314
321-
!!! tip
322-
Pots configurar git perquè configure automàticament la branca local
323-
perquè s'associe amb la branca remota amb el mateix nom
324-
amb l'opció `push.autoSetupRemote`.
325-
315+
!!! tip "Pots configurar git perquè configure automàticament la branca local perquè s'associe amb la branca remota amb el mateix nom amb l'opció `push.autoSetupRemote`."
326316
```bash
327317
git config --global push.autoSetupRemote true
328318
```
@@ -398,10 +388,7 @@ i decidir si volem incorporar-los al nostre repositori local.
398388
!!! docs "Documentació oficial de :simple-git: Git"
399389
[:octicons-link-external-16: `git fetch`](https://git-scm.com/docs/git-fetch)
400390
401-
!!! info
402-
L'opció `--prune` permet eliminar les referències de les branques remotes que ja no existeixen
403-
en el repositori remot.
404-
391+
!!! info "L'opció `--prune` permet eliminar les referències de les branques remotes que ja no existeixen en el repositori remot."
405392
Aquesta opció pot ser configurada per defecte amb la comanda `git config`.
406393
407394
```bash
@@ -498,28 +485,20 @@ git pull [<options>] [<remot> [<branca>]]
498485
!!! docs "Documentació oficial de :simple-git: Git"
499486
[:octicons-link-external-16: `git pull`](https://git-scm.com/docs/git-pull)
500487
501-
!!! warning
502-
La fusió (`merge`) implícita de `git pull` pot ser una [[branques#fusio-directa]]
503-
o es pot produir una [[branques#fusio-de-branques-divergents]] si
504-
la branca local i la branca remota divergeixen.
505-
506-
En aquest últim cas:
488+
!!! warning " La fusió (`merge`) implícita de `git pull` pot ser una [[branques#fusio-directa]] o es pot produir una [[branques#fusio-de-branques-divergents]] si la branca local i la branca remota divergeixen."
489+
En el cas d'una fusió de branques divergents:
507490
508491
- __Poden produir conflictes__. Si es produeixen, caldrà resoldre'ls manualment.
509492
- Executar directament `git pull` __generarà un commit de fusió__,
510493
que pot ser no és desitjable si es vol mantenir __una història lineal__.
511494
512-
!!! tip
513-
Per evitar __la fusió de branques divergents__ en `git pull`,
514-
es pot fer el següent:
515-
495+
!!! tip "Per evitar __la fusió de branques divergents__ en `git pull`, es pot fer el següent:"
516496
- `git pull --ff-only`: Incorpora els canvis de la branca remota
517497
__només si es pot fer una fusió directa (_fast-forward_)__.
518498
519-
En cas contrari, es produirà un error i no s'incorporaran els canvis.
499+
Si no és possible, es produirà un error i no s'incorporaran els canvis a la branca local.
520500
521-
A més, Git pot ser configurat perquè incloga aquesta opció
522-
en la comanda `git pull`.
501+
A més, Git pot ser configurat perquè incloga aquesta opció en la comanda `git pull`.
523502
524503
```
525504
git config --global pull.ff only

docs/apunts/04_avancat/amend.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@ nous canvis els fitxers del repositori, inclòs els que han segut modificats en
1717
El funcionament d'aquesta ordre consisteix en crear un nou _commit_ amb els canvis de l'__Àrea de Preparació__
1818
i els canvis del commit anterior. A més, el nou _commit_ substitueix l'anterior.
1919

20-
!!! warning
21-
Cal tindre en compte que el _commit_ original serà substituït pel nou _commit_,
22-
però si aquest ja ha estat publicat al repositori remot o té altres referències,
20+
!!! warning "Cal tindre en compte que el _commit_ original serà substituït pel nou _commit_"
21+
Si aquest ja ha estat publicat al repositori remot o té altres referències,
2322
aquestes referències no seran modificades i es podrien produir problemes
2423
en el repositori.
2524

0 commit comments

Comments
 (0)