Invio di patch

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

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:

Risorse

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 repository Git pertinente:

repo start NAME .

Puoi avviare più rami indipendenti contemporaneamente nello stesso repository. Il ramo NAME è locale nel tuo spazio di lavoro e non è incluso né in Gerrit né nell'albero dei sorgenti finale.

Fare il tuo cambiamento

Modifica i file di origine e convalida le modifiche.

Conferma le modifiche al tuo repository locale con questi comandi:

git add -A
git commit -s

Modifica le descrizioni

  • Riga 1: Titolo

    Fornire un riepilogo di una riga (50 caratteri massimo )

    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: vuota

    Mantieni questa riga vuota, sempre.

  • Riga 3: Corpo

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

    Questo deve contenere un massimo di 72 caratteri. Descrivi quale problema risolve la modifica e come. Sebbene ciò sia facoltativo quando si implementano nuove funzionalità, è molto utile per gli altri in un secondo momento se fanno riferimento a questa modifica, in particolare per il debug.

    Includere 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 l'e-mail, forniti durante repo init , vengono automaticamente aggiunti 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.
Per leggere un blog sulle buone descrizioni dei commit (con esempi), vedere How to Write a Git Commit Message di Chris Beams.

Caricamento su Gerrit

Dopo aver eseguito il commit della modifica nella cronologia personale, caricala su Gerrit con questo comando:

repo upload

Se hai avviato più rami nello stesso repository, ti verrà chiesto di selezionare quali caricare.

Dopo un caricamento riuscito, Repo ti fornisce l'URL di una nuova pagina su Gerrit . Fare clic sul collegamento fornito da Repo per visualizzare la patch sul server di revisione, aggiungere commenti o richiedere revisori specifici per la patch.

Richiesta di revisione

Dopo aver caricato le modifiche su Gerrit, la patch deve essere rivista e approvata dai proprietari del codice appropriati. Individua i proprietari del codice nei file OWNERS .

Per trovare i proprietari del codice appropriati e aggiungerli come revisori per la modifica, segui questi passaggi.

  1. Seleziona il collegamento SUGGERIMENTI PROPRIETARI nell'interfaccia utente di Gerrit per visualizzare un elenco di proprietari di codice per i file nella tua patch.

    suggerisci il link ai proprietari in Gerrit
    Figura 1. Suggerisci il collegamento ai proprietari in Gerrit
  2. Aggiungi i proprietari del codice dall'elenco come revisori per la tua patch.

Per determinare lo stato dei file nella tua patch, controlla le seguenti icone accanto ai file nella patch.

  • (icona segno di spunta): Approvato dal proprietario del codice
  • (icona a forma di croce): non approvato dal proprietario del codice
  • (icona dell'orologio): in attesa di approvazione da parte del proprietario del codice
Figura 2. Esempio di file con icone che mostrano lo stato di approvazione del proprietario del codice

Caricamento di una patch sostitutiva

Supponiamo che un revisore abbia esaminato la tua patch e abbia richiesto una piccola modifica. Puoi modificare il tuo commit all'interno di Git, il che si traduce in una nuova patch su Gerrit che ha lo stesso ID di modifica dell'originale.

git add -A
git commit --amend

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

Risoluzione dei conflitti di sincronizzazione

Se vengono inviate altre patch all'albero dei sorgenti che sono in conflitto con il tuo, ribasare la tua patch sopra il nuovo HEAD del repository dei sorgenti. Per farlo, esegui questo comando:

repo sync

Il comando repo sync recupera gli aggiornamenti dal server di origine, quindi tenta di rifondare automaticamente 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

Dopo aver completato il rebase automatico o manuale, esegui il repo upload per inviare la patch ribasata.

Dopo che una presentazione è stata approvata

Dopo che un invio ha superato il processo di revisione e verifica, Gerrit unisce automaticamente la modifica al repository pubblico. Altri utenti possono eseguire la 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/ , apporta le modifiche a monte, quindi informa i manutentori di Android della nuova versione a monte che contiene le modifiche.

Potresti anche caricare patch che determinano il monitoraggio di una nuova versione upstream. 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 sia un codice nuovo per Bionic, eseguire una correzione a monte, quindi un pull di un file completamente nuovo dal BSD appropriato.

kernel Android

Preferisci apportare tutte le modifiche a monte. Per indicazioni generali, segui le Linee guida per il contributo del kernel Android .

terapia intensiva

Apportare tutte le modifiche al progetto ICU in external/icu ( icu4c/ e icu4j/ ) nella home page di ICU-TC . Per ulteriori informazioni, vedere Invio di bug in terapia intensiva e richieste di funzionalità.

CLDR

La maggior parte dei dati linguistici in terapia intensiva proviene dal progetto Unicode CLDR . Invia tutte le richieste a monte utilizzando le richieste di modifica CLDR e aggiungi l'etichetta "Android".

LLVM/Clang/Compiler-rt

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

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 un abbonamento per inviare lì) o su Launchpad .

Apri SSL

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

V8

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

WebKit

Apporta tutte le modifiche al progetto WebKit in external/webkit nella pagina WebKit . Avvia 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 l'aggiunta di una soluzione proposta e l'inclusione dei test. Per i dettagli, vedere Contribuzione del codice a WebKit .

zlib

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