Aperçu
L'éditeur de sources Git (ci.android.com/edit) est un outil basé sur un navigateur permettant de modifier des fichiers dans le projet Android Open Source (AOSP) et de télécharger des modifications vers Gerrit. Il est destiné à apporter des modifications mineures à un petit nombre de fichiers et offre un flux de travail plus rapide que le téléchargement de l'arborescence des sources Android . Vous devez être familier avec le processus complet de soumission des modifications à AOSP à l'aide de Git, Repo et Gerrit avant d'utiliser l'éditeur de sources Git.
Lorsque vous modifiez un fichier à l'aide de l'éditeur de sources Git, tout le travail s'effectue sur votre ordinateur local, jusqu'à ce que vous téléchargiez les modifications pour créer une liste de modifications Gerrit.
Se connecter
- Chargez l'éditeur de source Git dans un navigateur.
Cliquez sur Connexion pour vous connecter à votre compte.
Figure 1. Bouton de connexion
Modifier les fichiers et les modifications
Git Source Editor a ces principaux workflows :
- Editez un ou plusieurs fichiers de votre choix, dans la branche que vous choisissez.
- Modifiez un changement. Lorsque vous modifiez une modification, le résultat dépend de la personne qui a créé la modification :
- Si vous avez créé la modification, vos modifications de l'éditeur de source Git sont corrigées dans la modification en tant que nouvel ensemble de correctifs.
- Si quelqu'un d'autre a créé la modification, vos modifications de l'éditeur de source Git créent une nouvelle modification qui vous appartient, en fonction de la modification que vous avez chargée.
Chargez ce que vous souhaitez modifier
Démarrez une session d'édition en chargeant soit un fichier, soit une modification.
Charger des fichiers
Entrez l'URL du fichier que vous souhaitez modifier dans la zone Chemin du fichier/modification en haut de la page.
Exemple de chemin de fichier : https://android.googlesource.com/platform/build/+show/refs/heads/main/Changes.md
Cliquez sur Charger le fichier ou modifier .
Figure 2. Chargement d'un fichier ou d'une modification
Le fichier se charge dans le volet de l'éditeur. Le volet de navigation à gauche du volet de l'éditeur est un navigateur de fichiers, qui ouvre le dépôt, avec votre fichier préchargé.
Figure 3. Un fichier chargé dans le volet d'édition
Vous pouvez utiliser le volet de navigation pour ouvrir plus de fichiers dans le même dépôt. Si vous ouvrez plusieurs fichiers, chaque fichier apparaît sous forme d'onglet dans la ligne située au-dessus du volet d'édition. Cliquez sur un onglet pour ouvrir ce fichier dans le volet d'édition.
Figure 4. Onglets pour les fichiers chargés
Charger une modification
Accédez à la modification que vous souhaitez modifier en entrant l'URL d'une liste de modifications Gerrit dans la zone Chemin du fichier/modification en haut de la page (voir Figure 2).
Exemple de lien de modification : https://android-review.googlesource.com/c/platform/build/soong/+/1284176
Les fichiers concernés par la modification s'ouvrent dans le volet d'édition (voir Figure 3).
Si la modification inclut plusieurs fichiers, chaque fichier apparaît sous forme d'onglet dans la ligne au-dessus du volet d'édition (voir Figure 4). Cliquez sur un onglet pour ouvrir ce fichier dans le volet d'édition.
Effectuez vos modifications
Modifiez les fichiers à l'aide du volet d'édition de texte. Les fichiers que vous modifiez apparaissent dans la liste Modifications en attente sous le volet d'édition. Si vous fermez accidentellement l'onglet d'un fichier contenant des modifications, vous pouvez rouvrir le fichier avec les modifications intactes en cliquant sur son nom dans la liste Modifications en attente.
Soumettre des changements
Vous créez et publiez votre modification dans Gerrit dans Git Source Editor. Ensuite, vous suivez l'approbation du changement dans Gerrit.
Créer et publier les modifications
Suivez cette procédure pour créer et publier les modifications que vous avez apportées.
Cliquez sur le bouton approprié :
- Cliquez sur Créer une modification si vous créez une nouvelle modification.
- Cliquez sur Mettre à jour la modification si vous mettez à jour une modification existante.
Une boîte de dialogue s'ouvre.
Figure 5. Boîte de dialogue Créer une modification
Saisissez une description de modification, qui deviendra la description de modification dans Gerrit. Cette description est obligatoire. Si vous modifiez une modification existante, vous pouvez modifier sa description si vous le souhaitez.
Vous pouvez éventuellement décocher ou cocher la case Publier lors de la création .
Cette case est cochée par défaut.
Si cette case est cochée lorsque vous créez la modification, la modification est immédiatement publiée sur Gerrit. Si la case n'est pas cochée, la modification est téléchargée sur Gerrit mais n'est pas publiée.
Cliquez sur Créer .
La modification est téléchargée sur Gerrit. Si vous avez coché la case Publier lors de la création , la modification est également publiée dans Gerrit. Le changement est lié dans une notification en haut de l'écran.
Figure 6. Modification de la notification créée
Suivre l’approbation des modifications dans Gerrit
Suivez le statut de soumission des modifications directement dans Gerrit, comme vous le feriez pour toute autre modification.
Figure 7. Suivi du statut de soumission des modifications dans Gerrit
Afficher les différences de fichiers
Cochez la case Diff sous le volet d'édition pour afficher les différences entre les modifications que vous avez apportées au fichier actif dans le volet d'édition. Ceci est utile lors de la modification d'un fichier et lors de la modification d'une modification existante.
Figure 8. Affichage des différences de fichiers
Rétablir les fichiers
Vous pouvez annuler les modifications d'un seul fichier ou de tous les fichiers de la liste de modifications en attente. Les deux options d'annulation annulent les modifications uniquement dans Git Source Editor. Ils ne mettront PAS à jour le changement dans Gerrit.
Rétablir un seul fichier
Pour restaurer un seul fichier, cliquez sur le X à côté du nom du fichier dans la liste Modifications en attente.
Figure 9. Section Modifications en attente
Rétablir tous les fichiers
Pour restaurer tous les fichiers en même temps, cliquez sur Rétablir tous les fichiers sous le volet d'édition.
Figure 10. Bouton Rétablir tous les fichiers
Une boîte de dialogue contextuelle s'ouvre. Cliquez sur Tout annuler pour annuler les modifications dans tous les fichiers en attente, ou cliquez sur Annuler pour conserver les modifications et continuer l'édition.
Figure 11. Boîte de dialogue de confirmation Rétablir tous les fichiers
Modifier une page directement depuis la recherche de code Android
Vous pouvez ouvrir un fichier dans Git Source Editor directement à partir de la recherche de code Android . Ceci est utile si vous devez localiser le fichier avant de le modifier.
Suivez cette procédure pour modifier un fichier directement depuis la recherche de code Android.
Dans Android Code Search (cs.android.com), accédez au fichier que vous souhaitez modifier.
Cliquez sur Modifier le code .
Figure 12. Bouton Modifier le code de recherche de code Android
Git Source Editor s'ouvre avec le fichier présélectionné pour l'édition.
Sélectionnez la branche Git dans laquelle vous souhaitez modifier le fichier dans la liste déroulante Sélectionner une branche git , puis cliquez sur Choisir une branche .
Figure 13. Sélection d'une branche Git à modifier
Le fichier s'ouvre dans le volet d'édition.
Continuez à éditer comme décrit dans la section Effectuer vos modifications .
Vous pouvez ouvrir des fichiers supplémentaires à modifier comme décrit dans la section Chargement de fichiers.
Résoudre des conflits
Pour résoudre les conflits :
Dans l'éditeur de source, accédez à la modification. Une fois la modification chargée, les fichiers en conflit sont répertoriés dans la partie inférieure de l'écran. Par exemple, la figure 14 montre que le fichier
Android.pbprésente un conflit.
Figure 14. Conflit avec l'éditeur de source
Cliquez sur un fichier en conflit. Le fichier se charge et affiche successivement et au sein des marqueurs Git (
<<<<<<<et>>>>>>>).
Figure 15. Marqueurs de conflit de l'éditeur de source
Résolvez le conflit en modifiant le fichier et en supprimant manuellement les marqueurs de conflit autour du contenu que vous souhaitez conserver. Supprimez également le contenu et les marqueurs de conflit pour le contenu que vous ne souhaitez pas conserver.
Cliquez sur Créer une modification pour créer une nouvelle modification. La boîte de dialogue Créer une modification apparaît.
Figure 16. Créer un changement
Tapez une description de modification et cliquez sur Créer .
Envoyer des commentaires
Utilisez le bouton bug
dans le coin supérieur droit pour fournir des commentaires sur Git Source Editor.