mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Fix typos
This commit is contained in:
parent
4fbc65aebe
commit
5aa10b42a9
4 changed files with 20 additions and 20 deletions
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/packaging_apps_git'
|
default: '/packaging_apps_git'
|
||||||
---
|
---
|
||||||
|
|
||||||
Git... Notre cher Git bien-aimé, que l'on peut aussi décrire comme "Goddamn Idiotic Truckload of sh*t" (Un stupide putain gros tas de m\*rde), selon Linus.
|
Git... Notre cher Git bien-aimé, que l'on peut aussi décrire comme "Goddamn Idiotic Truckload of sh\*t" (Un stupide putain gros tas de m\*rde), selon Linus.
|
||||||
Si vous ne connaissez pas encore Git, soyez sûr que vous serez bientôt d'accord avec cette description.
|
Si vous ne connaissez pas encore Git, soyez sûr que vous serez bientôt d'accord avec cette description.
|
||||||
|
|
||||||
YunoHost et toutes nos applications sont sur la forge Git GitHub. Ce qui veut dire que si vous voulez travailler sur une application, tôt ou tard vous allez devoir faire face à Git.
|
YunoHost et toutes nos applications sont sur la forge Git GitHub. Ce qui veut dire que si vous voulez travailler sur une application, tôt ou tard vous allez devoir faire face à Git.
|
||||||
|
@ -105,7 +105,7 @@ Quelle bonne idée !
|
||||||
Le mieux est de commencer par l'[application d'exemple](https://github.com/YunoHost/example_ynh). Mais comme nous l'avons déjà expliqué, vous ne voulez pas forker, parce que si vous le faites, vous allez garder ce lien vers l'application d'exemple et c'est vraiment ennuyeux.
|
Le mieux est de commencer par l'[application d'exemple](https://github.com/YunoHost/example_ynh). Mais comme nous l'avons déjà expliqué, vous ne voulez pas forker, parce que si vous le faites, vous allez garder ce lien vers l'application d'exemple et c'est vraiment ennuyeux.
|
||||||
Donc, vous allez le faire différemment. Vous allez cloner !
|
Donc, vous allez le faire différemment. Vous allez cloner !
|
||||||
|
|
||||||
##### git clone
|
##### `git clone`
|
||||||
|
|
||||||
Pour cloner, vous allez faire :
|
Pour cloner, vous allez faire :
|
||||||
```bash
|
```bash
|
||||||
|
@ -142,9 +142,9 @@ Il vous suffit de cloner le dépôt, le répertoire .git est le lien vers le dé
|
||||||
Vous avez bien votre copie local du dépôt, mais comme vous avez lu attentivement cette documentation jusque-là, vous savez que vous devez vous assurer d'être sur la branche testing avant de commencer à travailler.
|
Vous avez bien votre copie local du dépôt, mais comme vous avez lu attentivement cette documentation jusque-là, vous savez que vous devez vous assurer d'être sur la branche testing avant de commencer à travailler.
|
||||||
|
|
||||||
Pour voir les branches, et savoir sur quelle branche vous êtes réellement, alors que vous êtes dans le répertoire de votre dépôt, tapez `git branch`.
|
Pour voir les branches, et savoir sur quelle branche vous êtes réellement, alors que vous êtes dans le répertoire de votre dépôt, tapez `git branch`.
|
||||||
La branche courante est mise en évidence et précédée d'un "*".
|
La branche courante est mise en évidence et précédée d'un "\*".
|
||||||
|
|
||||||
#### git checkout
|
#### `git checkout`
|
||||||
|
|
||||||
S'il apparaît que vous n'êtes pas sur la branche où vous vouliez être, ou que vous êtes en fait sur master (ce qui est mal !), vous pouvez passer à une autre branche avec `git checkout`.
|
S'il apparaît que vous n'êtes pas sur la branche où vous vouliez être, ou que vous êtes en fait sur master (ce qui est mal !), vous pouvez passer à une autre branche avec `git checkout`.
|
||||||
```bash
|
```bash
|
||||||
|
@ -152,7 +152,7 @@ git checkout testing
|
||||||
```
|
```
|
||||||
*Lisez attentivement ce que Git dit quand vous validez une commande, n'oubliez jamais que Git est sournois...*
|
*Lisez attentivement ce que Git dit quand vous validez une commande, n'oubliez jamais que Git est sournois...*
|
||||||
|
|
||||||
#### git pull avant tout
|
#### `git pull` avant tout
|
||||||
|
|
||||||
Vous êtes enfin dans la bonne branche, et prêt à travailler.
|
Vous êtes enfin dans la bonne branche, et prêt à travailler.
|
||||||
**Attendez ! Un vilain piège vous attend...**
|
**Attendez ! Un vilain piège vous attend...**
|
||||||
|
@ -179,14 +179,14 @@ git add --all
|
||||||
Pour vérifier l'état actuel de votre validation, vous pouvez utiliser `git status`. Il vous montrera quels fichiers seront inclus dans votre commit, et quels fichiers sont modifiés, mais pas encore inclus.
|
Pour vérifier l'état actuel de votre validation, vous pouvez utiliser `git status`. Il vous montrera quels fichiers seront inclus dans votre commit, et quels fichiers sont modifiés, mais pas encore inclus.
|
||||||
`git status -v` vous indiquera également quelle partie des fichiers est modifiée. Une bonne façon de s'assurer que vous n'avez pas fait d'erreur avant de faire un commit.
|
`git status -v` vous indiquera également quelle partie des fichiers est modifiée. Une bonne façon de s'assurer que vous n'avez pas fait d'erreur avant de faire un commit.
|
||||||
|
|
||||||
#### git checkout -b
|
#### `git checkout -b`
|
||||||
|
|
||||||
Avant de faire un commit, ou après, ou avant de commencer à travailler. Quand vous en avez envie !
|
Avant de faire un commit, ou après, ou avant de commencer à travailler. Quand vous en avez envie !
|
||||||
Vous devriez envisager d'ajouter votre travail à une branche séparée, de cette façon, il sera facile de créer une pull request dans la branche testing et de discuter avec les autres packagers de ce que vous suggérez de changer.
|
Vous devriez envisager d'ajouter votre travail à une branche séparée, de cette façon, il sera facile de créer une pull request dans la branche testing et de discuter avec les autres packagers de ce que vous suggérez de changer.
|
||||||
|
|
||||||
Pour créer une nouvelle branche et passer à cette branche, vous pouvez utiliser `git checkout -b my_new_branch`.
|
Pour créer une nouvelle branche et passer à cette branche, vous pouvez utiliser `git checkout -b my_new_branch`.
|
||||||
|
|
||||||
#### Commit
|
#### `git commit`
|
||||||
|
|
||||||
Faire un commit, c'est simplement valider son travail dans Git. Comme vous pouvez le faire dans GitHub.
|
Faire un commit, c'est simplement valider son travail dans Git. Comme vous pouvez le faire dans GitHub.
|
||||||
Pour avoir les mêmes champs que vous aviez sur GitHub, avec le nom du commit, et une explication plus longue. Vous pouvez simplement utiliser `git commit`.
|
Pour avoir les mêmes champs que vous aviez sur GitHub, avec le nom du commit, et une explication plus longue. Vous pouvez simplement utiliser `git commit`.
|
||||||
|
@ -198,7 +198,7 @@ Si vous voulez faire un commit avec seulement un nom pour votre commit, vous pou
|
||||||
git commit -m "My commit name"
|
git commit -m "My commit name"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Push vers le dépôt distant
|
#### `git push` vers le dépôt distant
|
||||||
|
|
||||||
Vos modifications sont validées, mais uniquement sur votre clone local du dépôt. Maintenant, vous devez renvoyer ces modifications sur le dépôt distant sur GitHub.
|
Vos modifications sont validées, mais uniquement sur votre clone local du dépôt. Maintenant, vous devez renvoyer ces modifications sur le dépôt distant sur GitHub.
|
||||||
Pour ce faire, vous devez savoir quelle est votre branche actuelle. (Si vous ne le savez pas, `git branch` vous donnera cette information).
|
Pour ce faire, vous devez savoir quelle est votre branche actuelle. (Si vous ne le savez pas, `git branch` vous donnera cette information).
|
||||||
|
|
|
@ -7,7 +7,7 @@ routes:
|
||||||
default: '/packaging_apps_git'
|
default: '/packaging_apps_git'
|
||||||
---
|
---
|
||||||
|
|
||||||
Git... Our dear beloved Git, which can be described also as "Goddamn Idiotic Truckload of sh*t", according to Linus.
|
Git... Our dear beloved Git, which can be described also as "Goddamn Idiotic Truckload of sh\*t", according to Linus.
|
||||||
Be sure if you don't know Git yet that you will soon agree with that description.
|
Be sure if you don't know Git yet that you will soon agree with that description.
|
||||||
|
|
||||||
YunoHost and all our apps are on the Git forge GitHub. Which means that if you want to work on an app, sooner or later you're going to have to deal with Git.
|
YunoHost and all our apps are on the Git forge GitHub. Which means that if you want to work on an app, sooner or later you're going to have to deal with Git.
|
||||||
|
@ -95,15 +95,15 @@ Your repo will be moved into the organization, you don't have to remove the orig
|
||||||
As we have seen, you can do a lot of things directly on GitHub.
|
As we have seen, you can do a lot of things directly on GitHub.
|
||||||
But when you need to edit multiple files, or when you need to work on your code on your own, it's better to work directly on your computer.
|
But when you need to edit multiple files, or when you need to work on your code on your own, it's better to work directly on your computer.
|
||||||
|
|
||||||
Before going to the hellish part of Git, let's see 2 different ways to start working with Git.
|
Before going to the hellish part of Git, let's see two different ways to start working with Git.
|
||||||
|
|
||||||
#### First case: Creating a new package
|
#### First case: Creating a new package
|
||||||
|
|
||||||
You have shockingly discovered that the wonderful app you love to use everyday does not yet have its YunoHost package. And because you're nice, you decided to create yourself the package, so everyone will enjoy that app the way you do.
|
You have shockingly discovered that the wonderful app you love to use everyday does not yet have its YunoHost package. And because you're nice, you decided to create yourself the package, so everyone will enjoy that app the way you do.
|
||||||
What a good idea !
|
What a good idea!
|
||||||
|
|
||||||
The best is to start from the [example app](https://github.com/YunoHost/example_ynh). But as we have explained before, you don't want to fork, because if you do so, you're going to keep that link to the example app and it's really annoying.
|
The best is to start from the [example app](https://github.com/YunoHost/example_ynh). But as we have explained before, you don't want to fork, because if you do so, you're going to keep that link to the example app and it's really annoying.
|
||||||
So, you're going to do it differently. You're going to clone !
|
So, you're going to do it differently. You're going to clone!
|
||||||
|
|
||||||
##### git clone
|
##### git clone
|
||||||
|
|
||||||
|
@ -144,7 +144,7 @@ You do have your local copy of the repository, but because you have read careful
|
||||||
To see the branches, and to know on which you actually are, while into the directory of your repository, type `git branch`.
|
To see the branches, and to know on which you actually are, while into the directory of your repository, type `git branch`.
|
||||||
The current branch is highlighted and preceded by a `*`.
|
The current branch is highlighted and preceded by a `*`.
|
||||||
|
|
||||||
#### git checkout
|
#### `git checkout`
|
||||||
|
|
||||||
If it appears that you're not on the branch you wanted to be, or you're actually on master (which is bad !), you can move to another branch with `git checkout`
|
If it appears that you're not on the branch you wanted to be, or you're actually on master (which is bad !), you can move to another branch with `git checkout`
|
||||||
```bash
|
```bash
|
||||||
|
@ -152,7 +152,7 @@ git checkout testing
|
||||||
```
|
```
|
||||||
*Read carefully what Git says when you validate a command, do never forget that Git is sneaky...*
|
*Read carefully what Git says when you validate a command, do never forget that Git is sneaky...*
|
||||||
|
|
||||||
#### Git pull before anything else
|
#### `git pull` before anything else
|
||||||
|
|
||||||
You're finally on the right branch, and ready to work.
|
You're finally on the right branch, and ready to work.
|
||||||
**Wait ! A nasty trap is waiting for you...**
|
**Wait ! A nasty trap is waiting for you...**
|
||||||
|
@ -179,14 +179,14 @@ git add --all
|
||||||
To check the current status of your validation, you can use `git status`. It will show you which files will be included into your commit, and which files are modified, but not yet included.
|
To check the current status of your validation, you can use `git status`. It will show you which files will be included into your commit, and which files are modified, but not yet included.
|
||||||
`git status -v` will show also which part of the files are modified. A good way to be sure that you didn't make a mistake before committing.
|
`git status -v` will show also which part of the files are modified. A good way to be sure that you didn't make a mistake before committing.
|
||||||
|
|
||||||
#### git checkout -b
|
#### `git checkout -b`
|
||||||
|
|
||||||
Before committing, or after, or before starting to work. Whenever you feel like it !
|
Before committing, or after, or before starting to work. Whenever you feel like it !
|
||||||
You should consider adding your work to a separate branch, that way, it will be easy to create a pull request to merge into the testing branch and discuss with the other packagers what you suggest to change.
|
You should consider adding your work to a separate branch, that way, it will be easy to create a pull request to merge into the testing branch and discuss with the other packagers what you suggest to change.
|
||||||
|
|
||||||
To create a new branch and move to this branch, you can use `git checkout -b my_new_branch`.
|
To create a new branch and move to this branch, you can use `git checkout -b my_new_branch`.
|
||||||
|
|
||||||
#### Commit
|
#### `git commit`
|
||||||
|
|
||||||
To commit is simply to validate your work in Git. As you can do in GitHub.
|
To commit is simply to validate your work in Git. As you can do in GitHub.
|
||||||
To have the same fields that you had on GitHub, with the name of the commit, and a longer explanation. You can simply use `git commit`.
|
To have the same fields that you had on GitHub, with the name of the commit, and a longer explanation. You can simply use `git commit`.
|
||||||
|
|
|
@ -21,7 +21,7 @@ Nous parlerons ici de VirtualBox, pour son approche graphique facile à utiliser
|
||||||
## Installer VirtualBox
|
## Installer VirtualBox
|
||||||
|
|
||||||
Depuis un système GNU/Linux, installer simplement le paquet `virtualbox-qt`.
|
Depuis un système GNU/Linux, installer simplement le paquet `virtualbox-qt`.
|
||||||
Depuis un système Windows ou macOS, il faudra se référer à la page de [téléchargement de VirtualBox](https://www.virtualbox.org/wiki/Downloads) pour récupérer le fichier d'installation adéquat. Le paquet virtualbox est déprécié depuis Debian 9, un fichier d'installation .deb est disponible sur la même page.
|
Depuis un système Windows ou macOS, il faudra se référer à la page de [téléchargement de VirtualBox](https://www.virtualbox.org/wiki/Downloads) pour récupérer le fichier d'installation adéquat. Le paquet virtualbox est déprécié depuis Debian 9, un fichier d'installation `.deb` est disponible sur la même page.
|
||||||
|
|
||||||
Quel que soit votre système, il ne devrait pas être nécessaire d'installer l'extension pack ou les additions invités.
|
Quel que soit votre système, il ne devrait pas être nécessaire d'installer l'extension pack ou les additions invités.
|
||||||
|
|
||||||
|
|
|
@ -77,7 +77,7 @@ The machine always start on the "Current state" state.
|
||||||
|
|
||||||
## How do we connect to the virtual machine?
|
## How do we connect to the virtual machine?
|
||||||
|
|
||||||
Virtual machine connection is similar to any YunoHost server connection, that is by using `ssh`.
|
Virtual machine connection is similar to any YunoHost server connection, that is by using SSH.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ssh admin@my.domain
|
ssh admin@my.domain
|
||||||
|
@ -90,9 +90,9 @@ ssh admin@11.22.33.44
|
||||||
|
|
||||||
We can now work on the virtual machine using the commandline.
|
We can now work on the virtual machine using the commandline.
|
||||||
|
|
||||||
To easily copy the package files or use a graphical text editor, one can also connect via `sftp` using a file explorer.
|
To easily copy the package files or use a graphical text editor, one can also connect via SFTP using a file explorer.
|
||||||
|
|
||||||
It's a simple matter of using the `sftp://admin@my.domain/` address.
|
It's a simple matter of using the `sftp://admin@my.domain/` address.
|
||||||

|

|
||||||
|
|
||||||
> Note: on Windows or macOS, the file explorer does not natively support the `sftp` protocol...
|
> Note: on Windows or macOS, the file explorer does not natively support the SFTP protocol...
|
||||||
|
|
Loading…
Add table
Reference in a new issue