總覽
Git 原始碼編輯器 (ci.android.com/edit) 是一種以瀏覽器為基礎的工具,可用於編輯 Android 開放原始碼計畫 (AOSP) 中的檔案,並將變更內容上傳至 Gerrit。這項工具可用於對少數檔案進行小幅修改,且比下載 Android 原始碼樹狀結構更快完成工作流程。請先熟悉使用 Git、Repo 和 Gerrit 將變更提交至 AOSP 的完整程序,再使用 Git 原始碼編輯器。
使用 Git 來源編輯器編輯檔案時,所有工作都會在本機電腦上執行,直到您上傳變更來建立 Gerrit 變更清單為止。
登入
- 在瀏覽器中載入 Git 原始碼編輯器。
按一下「登入」即可登入帳戶。
圖 1. 「登入」按鈕
編輯檔案和變更
Git 原始碼編輯器有以下主要工作流程:
- 在所選分支中編輯一或多個檔案。
- 編輯變更。編輯變更時,結果取決於變更的建立者:
- 如果您建立了變更,Git 來源編輯器的編輯內容會以新的修補集形式套用至變更。
- 如果變更是由其他使用者所做,Git 原始碼編輯器會根據您載入的變更,建立您擁有的新變更。
載入要編輯的內容
載入檔案或變更,即可開始編輯工作階段。
載入檔案
在頁面頂端的「檔案/變更路徑」方塊中,輸入要編輯的檔案網址。
檔案路徑範例:https://android.googlesource.com/platform/build/+show/refs/heads/main/Changes.md
按一下「載入檔案或變更」。
圖 2. 載入檔案或變更
檔案會在編輯器窗格中載入。編輯器窗格左側的導覽窗格是檔案瀏覽器,可開啟原始碼集,並預先載入檔案。
圖 3. 檔案已載入至編輯窗格
您可以使用導覽窗格在同一個存放區中開啟更多檔案。如果您開啟多個檔案,每個檔案都會以分頁的形式顯示在編輯窗格上方的列中。按一下分頁標籤,即可在編輯窗格中開啟該檔案。
圖 4. 已載入檔案的分頁
載入變更
在頁面頂端的「檔案/變更路徑」方塊中輸入 Gerrit 變更清單的網址,即可前往要編輯的變更 (請參閱圖 2)。
變更連結範例:https://android-review.googlesource.com/c/platform/build/soong/+/1284176
變更中的檔案會在編輯窗格中開啟 (如圖 3 所示)。
如果變更內容包含多個檔案,每個檔案都會以分頁的形式顯示在編輯窗格上方的列中 (請見圖 4)。按一下分頁,即可在編輯窗格中開啟該檔案。
進行編輯
使用文字編輯窗格編輯檔案。您編輯的檔案會顯示在編輯窗格下方的「待處理變更」清單中。如果不小心關閉含有編輯內容的檔案分頁,只要在「待處理變更」清單中按一下檔案名稱,即可重新開啟檔案,並保留編輯內容。
提交變更
您可以在 Git 原始碼編輯器中建立並發布 Gerrit 變更。接著,您可以在 Gerrit 中追蹤變更的核准狀態。
建立並發布變更
請按照這個程序建立及發布所做的變更。
按一下適當的按鈕:
- 如要建立新的變更,請按一下「建立變更」。
- 如要更新現有變更,請按一下「更新變更」。
對話方塊隨即開啟。
圖 5. 「Create Change」對話方塊
輸入變更說明,這會成為 Gerrit 中的變更說明。這是必要說明。如果您要編輯現有變更,可以視需要編輯其說明。
視需要清除或選取「發布時發布」核取方塊。
系統預設會勾選這個方塊。
如果您在建立變更時選取這個方塊,變更會立即發布至 Gerrit。如果未選取該方塊,變更會上傳至 Gerrit,但不會發布。
按一下「建立」。
變更會上傳至 Gerrit。如果您選取「Publish on create」核取方塊,變更內容也會在 Gerrit 中發布。變更內容會連結至畫面頂端的通知。
圖 6. 變更建立通知
追蹤 Gerrit 中的變更核准作業
如同追蹤其他變更一樣,直接在 Gerrit 中追蹤變更提交狀態。
圖 7. 在 Gerrit 中追蹤變更提交狀態
查看檔案差異
選取編輯窗格下方的「Diff」核取方塊,即可查看您對編輯窗格中有效檔案所做的編輯差異。這項功能在變更檔案和編輯現有變更時很實用。
圖 8. 查看檔案差異
還原檔案
您可以還原單一檔案或待處理變更清單中的所有檔案變更。這兩種還原選項只會在 Git 原始碼編輯器中還原變更。不會更新 Gerrit 中的變更。
還原單一檔案
如要還原單一檔案,請按一下「待處理變更」清單中檔案名稱旁的 X。
圖 9.「待處理的變更」部分
還原所有檔案
如要一次還原所有檔案,請按一下編輯窗格下方的「還原所有檔案」。
圖 10. 「Revert all files」(還原所有檔案) 按鈕
彈出式對話方塊隨即開啟。按一下「全部還原」即可還原所有待處理檔案中的變更,或按一下「取消」保留變更並繼續編輯。
圖 11. 還原所有檔案的確認對話方塊
直接透過 Android 程式碼搜尋功能編輯頁面
您可以直接透過 Android 程式碼搜尋,在 Git 原始碼編輯器中開啟檔案。如果您需要先找出檔案再編輯,這項功能就很實用。
如要直接透過 Android 程式碼搜尋功能編輯檔案,請按照下列程序操作。
在 Android Code Search (cs.android.com) 中,前往要編輯的檔案。
按一下「編輯代碼」。
圖 12. Android 程式碼搜尋工具「Edit code」按鈕
Git 原始碼編輯器會隨即開啟,並預先選取要編輯的檔案。
從「Select a git branch」下拉式清單中選取要編輯檔案的 Git 分支版本,然後按一下「Pick branch」。
圖 13. 選取要編輯的 Git 分支版本
檔案會在編輯窗格中開啟。
請按照「編輯內容」一節的說明繼續編輯。
您可以開啟其他檔案進行編輯,如載入檔案一節所述
解決衝突
如要解決衝突問題,請按照下列步驟操作:
在原始檔案編輯器中,前往變更內容。變更載入後,畫面底部會列出衝突的檔案。舉例來說,圖 14 顯示
Android.pb
檔案有衝突。圖 14. 來源編輯器衝突
按一下有衝突的檔案。檔案會載入並依序顯示衝突的內容區塊,並顯示在 Git 標記 (
<<<<<<<
和>>>>>>>
) 中。圖 15. 來源編輯器衝突標記
如要修正衝突,請編輯檔案,並手動移除要保留的內容周圍的衝突標記。此外,請移除不想保留的內容和衝突標記。
按一下「Create Change」建立新的變更。系統隨即會顯示「Create Change」對話方塊。
圖 16. 建立變更
輸入變更說明,然後按一下「建立」。
提供意見
使用右上角的錯誤按鈕 ,提供有關 Git 來源編輯器的意見回饋。