概述
Git 原始碼編輯器(ci.android.com/edit) 是一個基於瀏覽器的工具,用於編輯 Android 開源專案 (AOSP) 中的檔案並將變更上傳到 Gerrit。它旨在對少量檔案進行較小的更改,並提供比下載 Android 原始碼樹更快的工作流程。在使用 Git 原始碼編輯器之前,您應該熟悉使用 Git、Repo 和 Gerrit 將變更提交至 AOSP 的完整流程。
當您使用 Git 原始碼編輯器編輯檔案時,所有工作都發生在您的本機電腦上,直到您上傳變更以建立 Gerrit 變更清單。
登入
- 在瀏覽器中載入Git 原始碼編輯器。
點擊登入以登入您的帳戶。
圖 1.登入按鈕
編輯文件和更改
Git 原始碼編輯器有以下主要工作流程:
- 在您選擇的分支中編輯您選擇的一個或多個檔案。
- 編輯更改。當您編輯更改時,結果取決於創建更改的人:
- 如果您建立了更改,您的 Git 原始碼編輯器編輯將作為新補丁集修補到更改中。
- 如果其他人建立了更改,您的 Git 原始碼編輯器編輯將根據您載入的變更建立您擁有的新變更。
載入您要編輯的內容
透過載入檔案或變更來啟動編輯會話。
載入文件
在頁面頂部的文件/更改路徑框中輸入要編輯的文件的 URL。
範例檔案路徑:https://android.googlesource.com/platform/build/+show/refs/heads/main/Changes.md
點擊載入檔案或更改。
圖 2.載入檔案或更改
文件載入到編輯器窗格中。編輯器窗格左側的導覽窗格是文件瀏覽器,用於開啟儲存庫並預先載入檔案。
圖 3.載入到編輯窗格中的文件
您可以使用導覽窗格在同一儲存庫中開啟更多檔案。如果您開啟多個文件,每個文件將在編輯窗格上方的行中顯示為選項卡。按一下選項卡可在編輯窗格中開啟該檔案。
圖 4.載入檔案的選項卡
載入更改
透過在頁面頂部的文件/更改路徑框中輸入 Gerrit 更改清單的 URL,導覽至要編輯的變更(請參閱圖 2)。
範例變更連結:https://android-review.googlesource.com/c/platform/build/soong/+/1284176
變更中的檔案在編輯窗格中開啟(請參閱圖 3)。
如果變更包含多個文件,則每個文件將在編輯窗格上方的行中顯示為標籤(請參閱圖 4)。按一下選項卡可在編輯窗格中開啟該檔案。
進行編輯
使用文字編輯窗格編輯文件。您編輯的檔案將顯示在編輯窗格下方的待定變更清單中。如果您不小心關閉了包含編輯內容的檔案的選項卡,則可以透過在「待處理的變更」清單中按一下檔案名稱來重新開啟該檔案並保留完整的編輯內容。
提交更改
您可以在 Git 原始碼編輯器中建立變更並將其發佈到 Gerrit。然後您可以在 Gerrit 中追蹤更改的批准情況。
創建並發布更改
請按照此程序創建並發布您所做的更改。
點選對應的按鈕:
- 如果您要建立新更改,請按一下建立更改。
- 如果您要更新現有更改,請按一下更新更改。
將會開啟一個對話框。
圖 5.建立更改對話框
輸入更改描述,這將成為 Gerrit 中的更改描述。此描述是必需的。如果您正在編輯現有更改,則可以根據需要編輯其描述。
(可選)清除或勾選「建立時發布」複選框。
預設情況下會選取此方塊。
如果在建立變更時選擇此框,則變更會立即發佈到 Gerrit。如果未選擇該框,更改將上傳到 Gerrit 但不會發布。
單擊創建。
更改已上傳到 Gerrit。如果您選擇了「建立時發布」複選框,則變更也會發佈在 Gerrit 中。更改連結在螢幕頂部的通知中。
圖 6.更改已建立的通知
在 Gerrit 中追蹤變更審批
直接在 Gerrit 中追蹤更改提交狀態,就像追蹤任何其他更改一樣。
圖 7.在 Gerrit 中追蹤更改提交狀態
查看文件差異
選擇編輯窗格下方的「差異」複選框可查看您對編輯窗格中活動文件所做的編輯的差異。這在更改文件和編輯現有更改時非常有用。
圖 8.查看檔案差異
恢復文件
您可以還原單一檔案或掛起更改清單中所有檔案的變更。兩個恢復選項僅恢復 Git 原始碼編輯器中的變更。他們不會更新 Gerrit 中的變更。
恢復單一文件
若要恢復單一文件,請按一下待更改清單中文件名稱旁邊的X。
圖 9.待定更改部分
恢復所有文件
若要一次還原所有文件,請按一下編輯窗格下方的還原所有文件。
圖 10.恢復所有檔案按鈕
將開啟一個彈出對話框。按一下「全部還原」以還原所有待處理檔案中的更改,或按一下「取消」以保留變更並繼續編輯。
圖 11.恢復所有檔案確認對話框
直接從 Android 程式碼搜尋編輯頁面
您可以直接從Android 程式碼搜尋在 Git 原始碼編輯器中開啟檔案。如果您需要在編輯之前找到該文件,這會很有幫助。
請按照此過程直接從 Android 程式碼搜尋編輯檔案。
在 Android 程式碼搜尋 (cs.android.com) 中,導覽至您有興趣編輯的檔案。
點選編輯代碼。
圖 12. Android 程式碼搜尋編輯程式碼按鈕
Git 原始碼編輯器將會打開,其中包含預先選擇用於編輯的檔案。
從選擇 git 分支下拉清單中選擇要在其中編輯檔案的 Git分支,然後按一下選擇分支。
圖 13.選擇要編輯的 Git 分支
該文件在編輯窗格中開啟。
按照“進行編輯”部分中的說明繼續編輯。
您可以開啟其他文件進行編輯,如載入文件部分所述
解決衝突
解決衝突:
在原始碼編輯器中,導航到更改。加載更改後,衝突的文件將在螢幕底部列出。例如,圖 14 顯示
Android.pb
檔案存在衝突。圖 14.來源編輯器衝突
點選衝突的檔案。檔案載入並連續顯示衝突的內容區塊,並在 Git 標記內(
<<<<<<<
和>>>>>>>
)。圖 15.原始碼編輯器衝突標記
透過編輯檔案並手動刪除要保留的內容周圍的衝突標記來修復衝突。另外,刪除您不想保留的內容和衝突標記。
按一下“建立變更”以建立新變更。將出現「建立變更」對話框。
圖 16.建立更改
輸入更改描述並點擊“建立” 。
傳送回饋
使用錯誤按鈕右上角提供有關 Git 原始碼編輯器的回饋。