Invio di patch

Questa pagina descrive l'intero processo di invio di una patch all'Android Open Source Project (AOSP), incluso come richiedere una revisione e tenere traccia delle modifiche con Gerrit .

Prerequisiti

Per iniziare, assicurati di aver eseguito quanto segue:

• Inizializzato il tuo ambiente di compilazione
• Scaricato il sorgente
• Creata una password utilizzando il generatore di password.

Risorse

• Per informazioni dettagliate su Repo e Git, vedere la pagina degli strumenti di controllo del codice sorgente .
• Per informazioni sui diversi ruoli all'interno della community Android Open Source, vedere la pagina Ruoli del progetto .
• Per informazioni sulle licenze relative al contributo del codice alla piattaforma Android, vedere la pagina Licenze .

Nota: per apportare modifiche ai progetti upstream utilizzati da Android, potrebbe essere necessario apportarle direttamente a quel progetto. Vedere Progetti a monte .

Per i contributori

Autenticazione con il server

Se condividi un indirizzo IP con altri utenti, le quote possono essere attivate anche per schemi di utilizzo regolari. Ciò può accadere quando, ad esempio, molti utenti sincronizzano nuovi client dallo stesso indirizzo IP in un breve periodo di tempo. L'accesso autenticato utilizza una quota separata per ciascun utente, indipendentemente dall'indirizzo IP. Per informazioni sull'attivazione dell'accesso autenticato, vedere Utilizzo dell'autenticazione .

Avvio di un ramo Repo

Per ogni modifica che intendi apportare, avvia un nuovo ramo all'interno del relativo repository Git:

repo start NAME .

You can start several independent branches at the same time in the same repository. The branch NAME is local to your workspace and isn't included either on Gerrit or in the final source tree.

Making your change

Modify the source files, and validate your changes.

Commit the changes to your local repository with these commands:

git add -A
git commit -s

Fornisci sempre una descrizione dettagliata della modifica con ogni commit. Segui il formato e le linee guida fornite in Descrizioni delle modifiche . Questo è molto importante; la descrizione della modifica viene inviata al repository AOSP pubblico. Segui questa guida sia che tu stia inviando patch o confermando modifiche per una nuova funzionalità.

Cambia le descrizioni

• Riga 1: Titolo

  Fornire un riepilogo di una riga ( massimo 50 caratteri)

  Questo formato è utilizzato da Git e Gerrit per vari display. È la parte più importante e più densa del tuo messaggio di commit. Prendi in considerazione l'utilizzo di prefissi per descrivere l'area che hai modificato, seguito da una descrizione della modifica che hai apportato in questo commit, come questo che ha ui come prefisso:

  ui: Removes deprecated widget

• Riga 2: Vuoto

  Mantieni questa riga vuota, sempre.

• Riga 3: Corpo

  Scrivi una descrizione più lunga, iniziando da questa riga.

  Questo deve eseguire il wrapping rigido a un massimo di 72 caratteri. Descrivi quale problema risolve il cambiamento e come. Sebbene questo sia facoltativo quando si implementano nuove funzionalità, è molto utile per gli altri in seguito se fanno riferimento a questa modifica, in particolare per il debug.

  Includi una breve nota di eventuali presupposti o informazioni di base che potrebbero essere importanti quando un altro collaboratore lavora su questa funzione.

Un ID di modifica univoco e il tuo nome e indirizzo email, che vengono forniti durante repo init , vengono aggiunti automaticamente al tuo messaggio di commit.

Ecco un esempio di messaggio di commit:

Line 1, Headline - a short description

Line 3, Body - Add the detailed description of your patch here. Use as many lines
as needed. You can write an overall description, then list specifics.

I6e3c64e7a:Added a new widget.
I60c539a8f:Fixed the spinning image.

To read a blog about good commit descriptions (with examples), see How to Write a Git Commit Message by Chris Beams.

Uploading to Gerrit

After you commit your change to your personal history, upload it to Gerrit with this command:

repo upload

If you started multiple branches in the same repository, you're prompted to select which ones to upload.

After a successful upload, Repo provides you with the URL of a new page on Gerrit. Click the link that Repo gives you to view your patch on the review server, add comments, or request specific reviewers for your patch.

Requesting a review

After you've uploaded your changes to Gerrit, the patch must be reviewed and approved by the appropriate code owners. Locate code owners in OWNERS files.

To find the appropriate code owners and add them as reviewers for your change, follow these steps.

1. Select the SUGGEST OWNERS link in the Gerrit UI to see a list of code owners for the files in your patch.

   

   Figure 1. Suggest owners link in Gerrit

2. Add code owners from the list as reviewers for your patch.

To determine the status of the files in your patch, check for the following icons next to the files in the patch.

• (checkmark icon): Approved by code owner
• (cross icon): Not approved by code owner
• (clock icon): Pending approval by code owner

Figure 2. Example of files with icons showing code owner approval status

Uploading a replacement patch

Suppose a reviewer looked at your patch and requested a small modification. You can amend your commit within Git, which results in a new patch on Gerrit that has the same change ID as the original.

Note: If you made other commits since uploading this patch, you must manually move your Git HEAD.

git add -A
git commit --amend

Quando carichi la patch modificata, questa sostituisce l'originale sia su Gerrit che nella tua cronologia Git locale.

Risoluzione dei conflitti di sincronizzazione

Se all'albero dei sorgenti vengono inviate altre patch che sono in conflitto con le tue, rebase la tua patch sopra il nuovo HEAD del repository dei sorgenti. Per fare ciò, esegui questo comando:

repo sync

Il comando repo sync recupera gli aggiornamenti dal server di origine, quindi tenta di ribasare automaticamente il tuo HEAD sul nuovo HEAD remoto.

Se il rebase automatico non riesce, eseguire un rebase manuale.

repo rebase

Un altro strumento per gestire il conflitto di rebase è git mergetool . Dopo aver unito correttamente i file in conflitto, esegui questo comando:

git rebase --continue

Al termine del rebase automatico o manuale, eseguire repo upload per inviare la patch rebase.

Dopo che una presentazione è stata approvata

Dopo che un invio ha superato il processo di revisione e verifica, Gerrit unisce automaticamente la modifica nel repository pubblico. Altri utenti possono eseguire repo sync per eseguire il pull dell'aggiornamento nei rispettivi client locali.

Per progetti a monte

Android fa uso di una serie di altri progetti open source, come il kernel Linux e WebKit, come descritto in Android Software Management . Per la maggior parte dei progetti che risiedono in external/ , apportare le modifiche a monte, quindi informare i manutentori di Android della nuova versione a monte che contiene le modifiche.

Potresti anche caricare patch che fanno sì che una nuova versione upstream venga tracciata. Tieni presente che queste possono essere modifiche difficili da apportare se il progetto è ampiamente utilizzato all'interno di Android, come la maggior parte di quelli più grandi menzionati di seguito, che di solito vengono aggiornati ad ogni versione.

Un caso speciale interessante è Bionic. Gran parte del codice proviene da BSD, quindi a meno che la modifica non riguardi un codice nuovo per Bionic, apporta una correzione a monte, quindi un pull di un file completamente nuovo dal BSD appropriato.

Kernel Android

Apporta tutte le modifiche a monte. Per indicazioni generali, segui le linee guida per il contributo del kernel Android e la pagina Sviluppo del codice del kernel per GKI .

terapia intensiva

Apportare tutte le modifiche al progetto ICU in external/icu (cartelle icu4c/ e icu4j/ ) nella home page ICU-TC . Vedere Invio di bug in terapia intensiva e richieste di funzionalità per ulteriori informazioni. Aggiungi l'etichetta "android" a tutte le richieste Jira upstream.

CLDR

La maggior parte dei dati linguistici in terapia intensiva proviene dal progetto Unicode CLDR . Invia tutte le richieste a monte in base a Contributing to CLDR e aggiungi l'etichetta "android".

LLVM/Clang/Compilatore-rt

Apporta tutte le modifiche ai progetti relativi a LLVM ( external/clang , external/compiler-rt , external/llvm ) nella pagina LLVM Compiler Infrastructure .

mksh

Apporta tutte le modifiche al progetto MirBSD Korn Shell su external/mksh inviando un'e-mail a miros-mksh sul dominio mirbsd.org (non è richiesto alcun abbonamento per inviare lì) o su Launchpad .

OpenSSL

Apporta tutte le modifiche al progetto OpenSSL in external/openssl nella pagina OpenSSL .

V8

Invia tutte le modifiche al progetto V8 su external/v8 nella pagina del problema V8 . Vedere Contribuire a V8 per i dettagli.

WebKit

Apporta tutte le modifiche al progetto WebKit in external/webkit nella pagina WebKit . Avviare il processo segnalando un bug di WebKit . Nel bug, usa Android per i campi Platform e OS solo se il bug è specifico di Android. È molto più probabile che i bug ricevano l'attenzione dei revisori dopo che è stata aggiunta una correzione proposta e sono stati inclusi i test. Vedere Contributo del codice a WebKit per i dettagli.

zlib

Apporta tutte le modifiche al progetto zlib su external/zlib nella home page di zlib .