Source code management/fr

Introduction
Le principal outil de gestion de code source du projet FreeCAD est Git, qui peut être facilement installé dans la plupart des systèmes d'exploitation à partir d'un gestionnaire de paquets ou directement à partir de Git's website. Nous vous conseillons de vous familiariser avec Git avant de travailler directement avec le code source FreeCAD. Visitez la page Git documentation pour obtenir le manuel de référence, ainsi que le Pro Git book pour apprendre à utiliser le système de manière générale. Le présent document porte sur l'utilisation de Git pour le développement FreeCAD. La compilation de FreeCAD est décrite dans Compilation.

Bien que Git soit principalement une application de terminal, il existe de nombreux clients graphiques qui facilitent le travail avec les branches, l’application de correctifs et la soumission de demandes d'extraction à une branche principale. Les exemples incluent gitk (la première interface graphique développée), gitg (Gnome), qgit (Qt), tig (Ncurses), git-cola et GitKraken (propriétaire). Veuillez consulter Developing FreeCAD with GitKraken pour une introduction sommaire à cet outil.

Accès au code source
Tout le monde peut accéder et obtenir une copie du code source de FreeCAD, mais seuls les gestionnaires de projet(s) peuvent en modifier le contenu. Vous pouvez avoir une copie du code, l'étudier et le modifier comme vous le souhaitez, mais si vous voulez que vos modifications soient prises en compte dans le code source officiel, vous devez effectuer un "pull request" sur le dépôt master. Les gestionnaires pourront alors vérifier vos modifications avant de les valider. Cette façon de développer est connue sous le nom de flux de travail des dictateurs et des lieutenants où les développeurs principaux (dictateurs) et développeurs de confiance (lieutenants) filtrent le code soumis par les développeurs et les utilisateurs indépendants.

Si votre code source change de manière significative, il vous est conseillé de l'expliquer dans la section "pull requests" du forum FreeCAD.



Dépôt officiel Github
Le code source de FreeCAD est hébergé sur https://github.com/FreeCAD/FreeCAD

Pour pouvoir contribuer et accéder au code source, vous devez avoir un compte GitHub.

In the past, the source code was hosted as an SVN repository, https://free-cad.svn.sourceforge.net/svnroot/free-cad. This was moved to GitHub on 2011 October 10th, with commit 120ca87015.

Therefore, there are many changes that were made before this time which are not recorded in the modern Git commit history.

Configuration de votre nom d'utilisateur Git
Les développeurs doivent faire un commit vers leur dépôt de leur code, en utilisant leur nom personnel d'utilisateur GitHub. Si ce n'est pas déjà fait globalement, vous pouvez le régler au niveau local pour le dépôt Git actuel comme ceci :

Où représente votre nom complet ou votre pseudonyme, utilisé pour identifier l'auteur d'un commit spécifique, et  indique le nom de votre compte sur GitHub.

Note sur les dépôts distants
Veuillez lire what-is-the-difference-between-origin-and-upstream-on-github#9257901 Quelle est la différence entre l'origine et l'upstream sur GitHub? (Stackoverflow) pour vous aider à comprendre la différence entre et  dans Git. Cette section explique comment définir les référentiels appropriés pour le développement. Essentiellement:
 * est votre branche personnelle du référentiel officiel de FreeCAD, à savoir, https://github.com/GITHUB_USERNAME/FreeCAD
 * est le référentiel officiel de FreeCAD, à savoir, https://github.com/FreeCAD/FreeCAD.

La distinction est importante, vous devez d'abord écrire votre code dans votre propre dépôt, avant de "pousser" ces changements sur le dépôt officiel.

Sur la base de ce qui précède, il existe deux manières de configurer votre environnement de développement Git:
 * 1ère méthode: fork GitHub et clonez votre fork localement
 * 2ème méthode: clonez FreeCAD directement sur votre machine locale et ajustez les serveurs distants

Nous recommandons la première méthode car c'est la plus rapide.

1ère méthode: Créez une branche sur GitHub et clonez votre branche localement
Vous allez d'abord créer le référentiel FreeCAD dans GitHub, puis cloner ce fork personnel sur votre ordinateur et enfin définir le référentiel.
 * Log in sur votre compte GitHub.
 * Accédez au référentiel officiel FreeCAD: https://github.com/FreeCAD/FreeCAD
 * En haut à droite de la page, appuyez sur le bouton "Fourchette". Cela créera une copie personnelle du référentiel FreeCAD sous votre nom d'utilisateur GitHub: https://github.com/GITHUB_USERNAME/FreeCAD
 * Sur votre machine, clonez votre nouvelle fourche FreeCAD. Il sera créé dans un répertoire.


 * Une fois le téléchargement terminé, entrez le nouveau répertoire source et définissez le référentiel.


 * Confirmez vos référentiels distants avec ; la sortie devrait être semblable à celle-ci


 * Maintenant, le développement peut commencer.

2ème méthode: clonez le dépôt officiel FreeCAD git sur votre ordinateur local
Vous allez d'abord créer le référentiel FreeCAD dans GitHub, mais vous clonerez le référentiel FreeCAD d'origine sur votre ordinateur local, puis modifierez vos télécommandes via le terminal.
 * Log in sur votre compte GitHub.
 * Accédez au référentiel officiel FreeCAD: https://github.com/FreeCAD/FreeCAD
 * En haut à droite de la page, appuyez sur le bouton "Fourchette". Cela créera une copie personnelle du référentiel FreeCAD sous votre nom d'utilisateur GitHub: https://github.com/GITHUB_USERNAME/FreeCAD
 * Clonez le référentiel FreeCAD d'origine. Il sera créé dans un répertoire.


 * Une fois le téléchargement terminé, entrez le nouveau répertoire source et définissez le référentiel.


 * Ensuite, configurez le référentiel.


 * Confirmez vos référentiels distants avec ; la sortie devrait être semblable à celle-ci


 * Maintenant, le développement peut commencer.

Si, pour une raison quelconque, les référentiels distants existent mais indiquent une adresse incorrecte, vous pouvez remédier à la situation en renommant le nom du référentiel distant. Par exemple, doit pointer sur votre branche personnelle; s'il pointe vers le référentiel FreeCAD d'origine, remplacez le nom de cette télécommande par  et ajoutez manuellement le référentiel.

Vous pouvez également afficher plus d'informations avec le mot clé.

Ramifications
Au lieu de travailler sur la version principale du code, les meilleures pratiques avec Git recommandent de créer une nouvelle branche chaque fois que vous souhaitez travailler sur une nouvelle fonctionnalité. Les branches sont peu coûteuses en ressources, elles ne copient pas l’ensemble de l’arborescence des sources, mais créent simplement un point dans le temps sur lequel vous allez écrire du code; ainsi, les branches aident à garder le travail en cours séparé du code principal.

L'ajout d'une nouvelle branche est réalisée en 2 étapes : Tout d'abord vous créez la branche, puis vous vous commutez sur celle-ci.

Sinon, effectuez les deux étapes avec une seule instruction:

Maintenant, vous pouvez changer de branche avec chaque fois que vous avez besoin de travailler dessus. Pour afficher les branches de votre projet et de la branche actuelle, utilisez l'opération seule ou ajoutez  ou  pour plus d'informations:

Une fois que vous avez effectué les changements et que vous les avez validés (commit), utilisez la ligne de commande avec les options suivantes pour visualiser les branches.

Validation des modifications
Une fois que vous êtes dans une nouvelle branche, éditez les fichiers sources que vous voulez avec votre éditeur de texte. Pour voir quels fichiers ont été modifiés, utilisez la commande et ; Lorsque que vous êtes satisfait de votre travail, validez le avec la commande  :

Contrairement à SVN, vous devez indiquer précisément les fichiers à valider. utilisez l'option pour enregistrer les modifications dans tous les fichiers modifiés. Votre éditeur de texte, par exemple, ou, s'ouvrira pour vous permettre d'écrire un message de validation.

Alternativement, ajoutez le message dans le "commit" lui-même:

Si vous créez de nouveaux fichiers ou répertoires, vous devez d'abord utiliser l'opération pour les ajouter au référentiel local avant de valider les modifications.

Où peut être n'importe quel répertoire ou fichier.

Rédaction de bons messages de commit
Vous devriez essayer de travailler en petites sections. Si vous ne pouvez pas résumer vos modifications en une seule phrase, il y a probablement trop longtemps, que vous avez fait un commit.

Pour les grands changements, il est important que vous disposiez de descriptions utiles et utiles de votre travail. FreeCAD a adopté un format mentionné dans le livre Pro Git, qui consiste en un court message, puis en un paragraphe descriptif plus grand.

Si vous effectuez de nombreux travaux connexes dans une branche, vous devez effectuer de nombreux petits commits (voir un forum post). Lorsque vous souhaitez fusionner ces modifications dans la branche principale, vous devez émettre

pour voir les messages individuels de commit. Vous pouvez ensuite écrire un message de haute qualité lors d’une fusion.

Lorsque vous fusionnez pour maîtriser, utilisez l'option et validez avec votre message de validation de qualité. Cela vous permettra d'être très libéral avec vos commits et vous aidera à fournir un bon niveau de détail dans les messages de validation sans autant de descriptions distinctes.

Regroupement des "commits"
Il est possible de regrouper plusieurs "commits" consécutifs dans 1 seul "commit", on appelle ça le "squashing". Ceci peut être utile dans les cas où vous avez effectué beaucoup de "petits commits" et que vous souhaitez les regrouper dans un seul "commit". Par exemple, lorsque vous changez simplement une variable, que vous corrigez des erreurs d'orthographe ou que vous ajustez la mise en forme de votre code. Vous devez faire des regroupements uniquement sur des "petits commits". Les grandes modifications effectuées sur plusieurs fichiers doivent contenir l'ensemble de l'historique des changements du commit.

Avec la commande, vous pouvez voir plusieurs "commits" consécutifs dont le plus récent est situé en haut de la liste. Dans cet exemple, plusieurs "commits" ont été effectués à partir de la "fonctionnalité A" pour réaliser l'implémentation de la "fonctionnalité B"; Nous souhaiterions maintenant regrouper tous les "commits" effectués pour la "fonctionnalité B" en un seul.

Utilisez la commande avec l'option  ou  pour sélectionner différents "commits" et les regrouper en un seul. Utilisez la valeur de hachage située juste devant le premier commit que vous voulez regrouper. Dans notre cas, il s'agit de celui qui correspond à la "fonctionnalité A".

un éditeur de ligne de commande comme ou  s'ouvrira pour vous montrer les "commits", mais cette fois avec le plus ancien en haut de la liste. Avant chaque "commit", le mot sera affiché. Supprimez le mot, et écrivez le mot ou juste la lettre  à la place, à l'exception de la première entrée; Ce "commit" est le plus ancien, donc tous les futurs "commits" seront regroupés dans celui-ci.

Sauvegardez le fichier et fermez l'éditeur.

L'éditeur s'ouvrira de nouveau. Vous pouvez maintenant ajouter un long message qui décrira tous les changements effectués comme s'ils étaient réunis dans un seul "commit". Sauvegardez le fichier et fermez l'éditeur une fois de plus. Ceci finira l'action de regroupement de ces "commits" avec le nouveau message que vous avez saisis.

Vous pouvez encore utiliser pour observer le nouvel historique des changements du commit. Dans ce cas, seul un simple "commit" pour la "fonctionnalité B", apparaitra au dessus du "commit" non modifié pour la "fonctionnalité A".

Publication de votre travail sur votre dépôt GitHub
Les branches locales de votre ordinateur ne sont pas automatiquement synchronisées avec les serveurs distants que vous avez spécifiés comme ou  (voir Référentiels distants); vous devez explicitement pousser les branches sur les serveurs distants, pour lesquels vous devez avoir un accès en écriture. Une fois que cela est fait, les branches deviennent publiques et disponibles pour être revues par d'autres développeurs.

Pour FreeCAD, vous devez placer votre branche locale dans le référentiel distant, à savoir,. Vous devez entrer votre nom d'utilisateur et votre mot de passe chaque fois que vous appuyez, sauf si vous avez configuré mise en cache. Veuillez lire Pushing dans un référentiel distant pour plus d'informations.

Lorsque vous travaillez avec une seule branche, vous devrez peut-être rebaser, écraser et corriger les commits plusieurs fois de manière interactive. Dans ce cas, votre historique de branche ne sera pas simple et vous ne pourrez pas le pousser vers le référentiel distant. Vous pouvez obtenir un message comme le suivant, indiquant qu'il n'est pas possible d'effectuer un push "fast-forward" (avance rapide).

Pour pousser enfin votre branche vers le dépôt distant, vous devez la "forcer à la pousser". Cela remplacera complètement votre branche distante par la branche réelle que vous avez hors ligne.

Le développeur standard n'a pas d'accès en écriture au référentiel https://github.com/FreeCAD/FreeCAD. Par conséquent, vous ne devez jamais envoyer de code à ce serveur distant.

Rebasing de l'amont
Pendant que vous travaillez sur votre propre branche, le code officiel de FreeCAD continue de s'améliorer avec les "commits" des autres développeurs, ce qui créé une différence de contenu avec votre branche personnelle.

.-A origin/myNewBranch / -o---Z FreeCAD upstream/master

Par conséquent, lorsque vous êtes prêt à fusionner votre branche sur le dépôt principal de FreeCAD, vous devez faire un "rebase" (sorte de re-synchronisation) de votre copie du dépôt, afin que son contenu se rapproche le plus possible de celui du dépôt officiel. Voir le document Git Branching - Rebasing pour plus d'informations.

Cette opération va télécharger le code à partir de la branche du dépôt  (le code source officiel de FreeCAD), et va le fusionner avec celui de votre branche courante, afin que vos modifications apparaissent tout en haut de la liste du dernier code officiel. Si personne n'a réalisé de modifications dans les fichiers sur lesquels vous avez travaillés, la fusion se fera sans erreurs. Si certains fichiers ont été modifiés en même temps par des personnes différentes, il se peut qu'il y ait des conflits qui devront être résolus.

.-A' origin/myNewBranch / -o---Z FreeCAD upstream/master

Pour résumer, vous devez être dans la branche appropriée, faire un "rebase" et puis un "push".

L'opération est équivalente à un  (récupération) suivit d'un  (fusion). Lorsque l'option est utilisée, à la place de faire un simple, c'est l'opération  qui sera exécutée.

Fusion de la branche (pull request)
Une fois que vous avez validé vos modifications, "mis à jour" votre branche à partir du dépôt principal et "poussé" votre branche sur le serveur, vous pouvez initier un "pull request". Un "pull request" informe les administrateurs du dépôt officiel de FreeCAD que vous souhaitez fusionner le nouveau code de votre branche avec le code officiel.

Dès que vous transmettez le code à votre référentiel, GitHub vous offre la possibilité de comparer et de créer une demande d'extraction par rapport au Référentiel. En appuyant sur le bouton, vous ouvrirez une interface qui vous permettra de choisir quel référentiel est la "base", cible de la fusion, et quelle est la "tête", de votre code supplémentaire. Une vérification rapide sera effectuée par le système vous indiquant s'il n'y a pas de conflit avec les fichiers que vous avez modifiés; si vous avez travaillé sur des fichiers que personne n'a touchés, votre branche pourra fusionner proprement. De plus, il vous montrera un éditeur de texte afin que vous puissiez écrire un message documentant vos modifications. il affichera également le nombre de commits dans votre branche, le nombre de fichiers modifiés et une vue indiquant les différences entre la "base" et la "tête", afin que tout le monde puisse voir immédiatement les modifications que vous souhaitez apporter.

Cliquez sur pour continuer. Un message apparaîtra indiquant que certaines vérifications doivent être effectuées sur le code. C'est un système qui compile automatiquement FreeCAD et exécute les tests unitaires. Si les tests réussissent, la demande d'extraction aura plus de chance d'être fusionnée dans le code principal, sinon un rapport sera généré indiquant les erreurs rencontrées. Voir FreeCAD.

Some checks haven’t completed yet


 * continuous-integration/travis-ci/pr Pending — The Travis CI build is in progress |Required|

Si les tests réussissent, vous verrez un message tel que le suivant

Tous les tests ont passés


 * continuous-integration/travis-ci/pr — The Travis CI build passed |Required|

Cette branche n'a pas de conflits avec la branche de base Seules les personnes ayant un accès en écriture à ce référentiel peuvent fusionner des demandes d'extraction.

Vous devez maintenant attendre que les administrateurs fusionnent votre branche. vous serez averti lorsque cela se produira.

Si vous le souhaitez, vous pouvez supprimer la branche qui vient d'être fusionnée, ou même votre branche entière de FreeCAD, car votre propre code est déjà inclus à la fin de la branche principale.

vous pouvez continuer à travailler sur la même branche en attendant l'approbation de la fusion; si vous  à nouveau, une deuxième validation de fusion sera mise en file d'attente dans la même demande d'extraction, et un autre test automatisé sera effectué. En d’autres termes, même si vos administrateurs n’approuvent pas encore vos fusions, vous pouvez continuer à appliquer des modifications à votre référentiel, ce qui mettra ces commits en file d'attente dans la même demande d'extraction du référentiel. L'utilisation d'une seule demande d'extraction pour mettre en file d'attente plusieurs commits individuels est souvent souhaitable pour de petites modifications. Pour les ajouts importants au code source, vous devez créer une autre branche, d'y développer vos fonctionnalités, puis soumettre une demande d'extraction distincte pour cette branche.

L'interface de requête d'extraction peut être utilisée chaque fois que vous souhaitez soumettre du code à partir de vos propres référentiels vers un autre référentiel de GitHub. Vous pouvez également l'utiliser pour fusionner du code dans la direction opposée, des branches d'autres personnes à la vôtre, ou même entre vos propres branches. Dans le dernier cas, puisque vous possédez les branches, les fusions peuvent être approuvées par vous-même immédiatement.

Maintien du dépôt GitHub à jour
Une fois que vous avez créé FreeCAD, votre référentiel personnel existe indépendamment de l'original. Lorsque le référentiel d'origine comporte de nouveaux commits, GitHub vous informera que votre référentiel personnel est en retard sur le nombre de commits:

De la même manière, si vous avez créé une branche de développement avec un nouveau code, GitHub vous informera que cette branche est en avance en nombre de validations; c'est-à-dire que cette branche contient des modifications qui n'ont pas été fusionnées dans le référentiel officiel de FreeCAD:

Pendant le développement, les deux cas sont possibles, car votre propre branche peut ne pas avoir de commits faits par d’autres développeurs, mais inclure de nouveaux commits de votre part:

Lors du développement du code, il est recommandé de rebaser la branche dans laquelle vous travaillez actuellement, car cela mettra votre branche toujours devant le code maître FreeCAD.

Quant à votre branche originale, elle ne sera jamais automatiquement mise à jour par GitHub; c'est quelque chose que vous devez faire vous-même. Passez à la branche, puis à à partir de  qui effectue un  et ,  puis poussez cette branche  mise à jour vers votre référentiel  distant.

Une fois cela fait, GitHub vous indiquera que vous êtes synchronisé avec le référentiel.

Maintenant que votre est à jour, vous pouvez décider de le changer et de supprimer l’autre branche que vous avez utilisée précédemment pour développer une fonctionnalité.

Pour supprimer la branche du référentiel distant, vous pouvez utiliser l'opération. Normalement, vous poussez une branche locale; cela crée une branche distante portant le même nom que votre branche locale.

Toutefois, si vous utilisez la notation, la branche locale est créée dans le référentiel distant sous un nom différent:

Par conséquent, vous pouvez supprimer la branche distante en poussant une branche locale vide:

Maintenant que vous ne disposez que d'un à jour, vous pouvez créer une nouvelle branche et répéter les étapes de modification de fichiers, de validation, d'insertion, de soumission d'une demande d'extraction, de fusion et de mise à jour.

Si vous ne souhaitez pas supprimer votre branche déjà personnalisée, vous pouvez forcer la mise à jour pour correspondre à la valeur de la mise à jour ; vous pouvez ensuite faire ce que vous voulez, y compris ajouter plus de commits et le pousser dans le référentiel distant.

Réinitialiser une branche comme ceci n’est généralement pas nécessaire. Dans la plupart des cas, vous souhaitez suivre la séquence de création d'une nouvelle branche, de validation des modifications, de transmission de ces modifications, de fusion de la branche, puis de suppression de la branche.

Résolution des conflits de fusion
La fusion de branches avec ou la redistribution de votre branche avec  présente parfois des conflits de fichiers pouvant avoir été modifiés par un autre auteur en même temps. Si cela se produit, vous devriez voir les modifications des deux côtés, de l'autre auteur et du vôtre, puis décider de la meilleure façon d'inclure les deux ensembles de modifications. Ceci est normalement un processus manuel qui ne peut pas être automatisé; le programmeur doit comprendre le code et décider du code à déplacer, réécrire ou abandonner pour résoudre le conflit.

Lorsqu'un conflit survient, un message comme celui-ci peut apparaître.

Si un outil de différenciation spécialisé est installé et configuré pour Git, par exemple, celui de Gnome Meld, le conflit peut être examiné et résolu en utilisant l'opération ..

L'outil de fusion affiche normalement trois colonnes; les deux colonnes sur les côtés affichent les deux fichiers en conflit, tandis que la colonne du milieu affiche le nouveau code qui sera enregistré et finalement validé. Par conséquent, cette colonne centrale doit être modifiée de manière à intégrer le code des deux colonnes latérales. Une fois le conflit résolu et le nouveau code source (la colonne centrale) enregistré, vous pouvez fermer l’outil de fusion. Ensuite, l'opération ou  peut continuer.

Pour plus d'informations sur la fusion et la résolution des conflits, voir:
 * explications git-scm sur la manière dont les conflits sont présentés avec.
 * Conflits de fusion élémentaires et Outils Git - Fusion avancée
 * Article de GitHub sur la résolution des problèmes de fusion par la ligne de commande.
 * Personnalisez votre outil de fusion préféré lorsque vous rencontrez un conflit entre plusieurs git.

Inspecter les changements
Inspectez l'historique des modifications apportées à un fichier qui a subit plusieurs "commits" avec l'opération :

Où peut être n'importe quel répertoire ou fichier. Au lieu de, vous pouvez également utiliser les raccourcis ou.

Inspecter les changements entre deux branches
Inspectez les modifications entre deux branches avec les opérations et  avec les noms des branches:

L'opération affiche les validations, tandis que  indique les modifications réelles apportées aux fichiers.

Réinitialiser les fichiers et les répertoires
Si vous avez accidentellement apporté des modifications à un fichier ou à un répertoire, vous souhaiterez peut-être annuler complètement ces modifications pour obtenir l'état précédent du code source.

Cela peut être fait rapidement en utilisant l'opération :

Cela restaurera le (un fichier ou un répertoire) à l'état dans lequel il se trouve à l'extrémité de la branche, en ignorant les modifications qui n'ont pas été validées. Si est le point unique, Tous les fichiers du répertoire en cours seront restaurés.

Si vous avez accidentellement ajouté des fichiers et des répertoires, vous pouvez utiliser l'opération :

Ceci forcera la suppression de tous les fichiers et répertoires qui ne font pas l'objet d'un suivi par le référentiel, c'est-à-dire ceux qui n'ont pas été inclus précédemment avec l'opération.

Pour réinitialiser complètement le référentiel en perdant toutes les modifications non validées, utilisez l'opération :

Où est la pointe du référentiel. Un autre commit peut également être utilisé.

L'opération annule également les modifications. Cependant, cette commande fait cela en ajoutant un autre commit à l'historique; dans de nombreux cas, cela n'est pas souhaité.

Taille des vieilles branches
Si vous avez engagé de nombreuses branches dans le référentiel, vous souhaiterez peut-être supprimer ces branches de votre système local car elles ont déjà été fusionnées. La branche en ligne du référentiel peut être supprimée immédiatement après la fusion. Ensuite, vous pouvez supprimer les références locales à cette branche en utilisant les options ou  pour les opérations  et.

Enfin, vous pouvez supprimer les branches localement

Après un certain temps, il est également recommandé de procéder à la récupération d'espace disque, en utilisant l'opération. Cela supprimera les fichiers inutiles et compressera les révisions de fichiers locaux, afin d'optimiser l'utilisation du disque local du référentiel.

Travailler avec des patchs
Bien que Git vous permette de fusionner le code de différentes branches localement sur votre ordinateur via la commande ou d'effectuer un "pull request" sur le serveur distant (remote repository), il est parfois préférable de créer un patch qui peut être envoyé en tant que pièce jointe par e-mail au lieu de soumettre un PR. Le flux de travail suivant explique comment procéder:

Création de correctifs

 * Il est conseillé de travailler dans une nouvelle branche et non pas directement sur la branche master de votre dépôt. La première étape consiste donc à s'assurer que vous êtes dans la bonne branche et le cas échéant à s'y raccorder. Les commandes suivantes permettent de réaliser ces opérations :


 * Maintenant, utilisez la commande et l'option  pour envoyer le résultat vers la sortie standard STDOUT (Ecran); le résultat sera ensuite redirigé vers un fichier qui par commodité sera créé dans un dossier de niveau supérieur à celui du code source.


 * Une autre méthode

Le nombre d'accents circonflexes ou le nombre situé derrière le tilde ~  indique le nombre de "commits" qui devront être considérés, à savoir par exemple  ou  va créer 3 correctifs pour 3 "commits".

Cette commande va créer un "patch" ou une série de "patchs" en respectant la convention de nommage suivante :

où est un nombre compris entre  et, et où le message du "commit" forme la majorité du nom du fichier, par exemple :

Application des correctifs
Git a la capacité de fusionner des correctifs/diffs. Pour en savoir plus à ce sujet, lisez la référence suivante: Application des patches avec Git

Si vous avez déjà le fichier du correctif dans votre système, il suffit juste de l'appliquer.

Vous pouvez utiliser pour télécharger un correctif depuis un site web, et ensuite l'appliquer via la commande.

Conseil utile: ajoutez simplement .diff ou .patch à la fin de l'URL d'une page de validation GitHub, d'une demande d'extraction ou d'une vue de comparaison et vous obtiendrez une vue de cette page. Exemple:
 * Page GitHub pour un "commit classique" : https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621
 * Page GitHub pour un "Diff" : https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.diff
 * Page GitHub pour un correctif : https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch

Vous pouvez pointer vers le "commit" d'un correctif particulier dans un dépôt, et le faire suivre directement vers  pour appliquer le correctif.

curl https://github.com/FreeCAD/FreeCAD/commit/c476589652a0f67b544735740e20ff702e8d0621.patch | git apply -

Inverser un patch
Lorsque vous appliquez un correctif, vous modifiez certains fichiers. Cependant, ces modifications ne sont pas permanentes tant que vous n'avez pas validé les modifications. Par conséquent, si vous souhaitez rétablir un correctif, utilisez les instructions suivantes.

Cette commande annulera les modifications qui ont été appliquées, si vous avez toujours accès au fichier original du correctif:

Cette commande alternative enlèvera toutes les modifications non validées dans la branche.

Stockage temporaire dans le cache des git commits
Supposons que vous travaillez sur une branche et que vous apportiez des modifications à la source qui sortent du cadre de votre branche actuelle; autrement dit, ces changements seraient meilleurs dans une autre branche que dans la branche actuelle. La commande peut être utilisée pour stocker temporairement ces modifications locales non validées.

Si à l'avenir vous souhaitez utiliser ces commits, vous pouvez les extraire de la réserve puis dans votre branche active.

Ou si vous décidez que vous n'aimez plus ces commits sauvegardés, vous pouvez les supprimer complètement de la réserve.

Vous pouvez lister plusieurs commits stash avec

Pour en savoir plus, lisez Useful tricks you might not know about Git stash.

Vérifier sur GitHub les demandes locales
Checkout GitHub pull requests locally

Numéro de révision FreeCAD
Contrairement à Subversion qui incrémente le numéro de révision, Git génère une valeur de hachage SHA-1 à chaque "commit". Une valeur de hachage est une longue chaîne de caractères alphanumériques qui ressemble à ceci :

Quelle est la dernière révision de FreeCAD Dev ?
Pour trouver le dernier numéro de révision d'une branche particulière, utilisez l'opération avec l'option. Donnez le nom de la branche, du référentiel distant, de la balise ou un pointeur spécial tel que, pour indiquer le dernier commit dans cet objet particulier.

ou parcourez le dépôt sur GitHub et lisez le nombre de mises à jour (commits) effectuées dans la branche correspondante.

Quel est le numéro de révision correspondant à la valeur de hachage d'un "commit" ?
Comme la valeur de hachage est une chaîne de caractères alphanumériques, il n'est pas très utile de savoir si un "commit" est plus ancien ou plus récent qu'un autre. Pour trouver le numéro de révision correspond à une valeur de hachage particulière, utilisez à nouveau l'opération ; l'entrée peut être la valeur de hachage complète ou une valeur de hachage partielle qui est unique, généralement les 7 premiers chiffres sont suffisants.

Quel est la valeur de hachage correspondante au numéro de révision d'un "commit" ?
Si nous avons un "commit" qui porte le numéro 15000 et que nous voulons trouver la valeur de hachage correspondante, nous allons avoir besoin de calculer le nombre de "commits" réalisés entre ce "commit" et le dernier "commit". Dans un premier temps, cherchons le numéro du dernier "commit".

Puis, soustrayons à ce résultat le "commit" que nous voulons.

Puis, utilisez la commande pour afficher la liste des "commits" et des valeurs de hachage. L'option permet de sauter la différence dans les "commits" que nous avons calculez, ce qui nous permet d'aller directement à la valeur de hachage que nous recherchons.

Il se peut que le résultat vous affiche 2 "commits" assez proches, confirmez que ce soit le bon numéro de "commit". Si ce n'est pas le cas, choisissez simplement le prochain "commit" dans la séquence (avant ou après) et vérifiez à nouveau.


 * Show the commits juste avant un commit particulier dans GitHub: dans la barre d’adresse du navigateur, changez le mot par  pour afficher la liste.
 * Trouver le numéro de révision du commit
 * Trouver le numéro de révision du commit
 * Recherche de la valeur de hachage correspondante pour un numéro de validation particulier

Comment le numéro de révision dans l'aide de FreeCAD est-il généré ?
Le numéro de version qui apparait avec l'outil Std About est définit dans le fichier, qui est créé au moment de la compilation lorsque l'outil est exécuté. Lisez le post Extract version number from git source pour plus d'informations.

Ajout d'autres référentiels (distants)
Plusieurs collaborateurs du projet FreeCAD ont leurs propres référentiels Git où ils développent leur travail où ils expérimentent de nouvelles idées avant d'être prêts à être inclus dans le code source officiel. Vous voudrez peut-être obtenir leurs sources afin de tester leur code vous-même lorsqu'ils font une demande d'extraction.

Utilisez la commande pour ajouter ces autres référentiels afin que vous puissiez  (récupérer) et  (pousser) suivre leurs codes.

Par exemple, ajoutons le dépôt de Bernd:

La commande télécharge les références à partir de ce dépôt distant.

Répertoriez toutes les branches de votre propre dépôt et celles de vous avez ajoutées. Les branches de Bernd s'afficheront sous la forme.

Maintenant, regardons une liste résumée des 10 derniers commits de la branche de Bernd.

Maintenant, nous pouvons vérifier la branche à inspecter.

Ensuite, nous pouvons créer une branche locale basée sur la branche distante. Cette branche locale, nous pouvons la modifier et y ajouter notre propre code.

Vous pouvez souhaiter la branche nouvellement obtenue sur la branche  pour vous assurer qu'elle utilise le dernier code. S'il y a des conflits, ils devront être résolus à ce stade.

La nouvelle branche est prête à être modifiée et compilée comme décrit dans Compiler.

Dirigez vous vers la section de développement du forum FreeCAD pour discuter du développement.

Lecture complémentaire

 * Développer FreeCAD avec GitKraken, un guide pour utiliser l'interface graphique avec Git.
 * Git pour les paresseux, un guide très concis des principales commandes de.
 * Le Pro Git book livre open source vous enseignant Git; il est disponible en versions électronique et imprimée.
 * Le Visual Git guide, une référence avec des diagrammes expliquant les opérations les plus courantes avec Git.
 * Git Tutorial for Beginners: Command-Line Fundamentals, vidéo de Corey Schafer.
 * Introduction to Git - Core Concepts, vidéo de David Mahler.