Редактор исходного кода Git

Обзор

Редактор исходного кода Git (ci.android.com/edit) — это браузерный инструмент для редактирования файлов в проекте Android с открытым исходным кодом (AOSP) и загрузки изменений в Gerrit. Он предназначен для внесения незначительных изменений в небольшое количество файлов и обеспечивает более быстрый рабочий процесс, чем загрузка дерева исходного кода Android . Прежде чем использовать редактор исходного кода Git, вы должны быть ознакомлены с полным процессом отправки изменений в AOSP с помощью Git, Repo и Gerrit.

Когда вы редактируете файл с помощью редактора исходного кода Git, вся работа происходит на вашем локальном компьютере, пока вы не загрузите изменения для создания списка изменений Gerrit.

Авторизоваться

  1. Загрузите редактор исходного кода Git в браузере.
  2. Нажмите «Войти» , чтобы войти в свою учетную запись.

    Кнопка входа

    Рисунок 1. Кнопка входа в систему

Редактирование файлов и изменений

Редактор исходного кода Git имеет следующие основные рабочие процессы:

  • Отредактируйте один или несколько файлов по вашему выбору в выбранной вами ветке.
  • Отредактируйте изменение. Результат редактирования изменения зависит от того, кто создал это изменение:
    • Если вы внесли изменение, ваши изменения в редакторе исходного кода Git будут добавлены в изменение как новый набор исправлений.
    • Если изменение создал кто-то другой, ваши изменения в редакторе исходного кода Git создают новое изменение, которым вы владеете, на основе загруженного вами изменения.

Загрузите то, что хотите редактировать

Начните сеанс редактирования, загрузив файл или изменение.

Загрузить файлы

  1. Введите URL-адрес файла, который вы хотите отредактировать, в поле «Путь к файлу/изменению» вверху страницы.

    Пример пути к файлу: https://android.googlesource.com/platform/build/+show/refs/heads/main/Changes.md.

  2. Нажмите «Загрузить файл или изменить» .

    Загрузка файла или изменение

    Рисунок 2. Загрузка файла или изменение

    Файл загружается в панели редактора. Панель навигации слева от панели редактора представляет собой браузер файлов, который открывает репозиторий с предварительно загруженным файлом.

    Файл загружен в панель редактирования

    Рисунок 3. Файл, загруженный в область редактирования

Вы можете использовать панель навигации, чтобы открыть больше файлов в одном репозитории. Если вы открываете несколько файлов, каждый файл отображается в виде вкладки в строке над панелью редактирования. Щелкните вкладку, чтобы открыть этот файл на панели редактирования.

Вкладки для загруженных файлов

Рисунок 4. Вкладки для загруженных файлов

Загрузить изменение

Перейдите к изменению, которое хотите отредактировать, введя URL-адрес списка изменений Gerrit в поле «Путь к файлу/изменению» в верхней части страницы (см. рис. 2).

Пример ссылки на изменение: https://android-review.googlesource.com/c/platform/build/soong/+/1284176.

Файлы в изменении открываются на панели редактирования (см. рис. 3).

Если изменение включает несколько файлов, каждый файл отображается в виде вкладки в строке над панелью редактирования (см. рис. 4). Щелкните вкладку, чтобы открыть этот файл на панели редактирования.

Внесите свои изменения

Редактируйте файлы с помощью панели редактирования текста. Файлы, которые вы редактируете, отображаются в списке «Ожидание изменений» под панелью редактирования. Если вы случайно закрыли вкладку файла с изменениями, вы можете снова открыть файл без изменений, щелкнув его имя в списке Ожидающие изменения.

Отправить изменения

Вы создаете и публикуете изменения в Gerrit в редакторе исходного кода Git. Затем вы отслеживаете утверждение изменения в Gerrit.

Создайте и опубликуйте изменения

Следуйте этой процедуре, чтобы создать и опубликовать внесенные вами изменения.

  1. Нажмите соответствующую кнопку:

    • Нажмите «Создать изменение» , если вы создаете новое изменение.
    • Нажмите «Обновить изменение» , если вы обновляете существующее изменение.

    Откроется диалоговое окно.

    Диалоговое окно «Создать изменение»

    Рисунок 5. Диалоговое окно «Создать изменение»

  2. Введите описание изменения, которое станет описанием изменения в Gerrit. Это описание является обязательным. Если вы редактируете существующее изменение, вы можете отредактировать его описание, если хотите.

  3. При необходимости снимите или установите флажок Публиковать при создании .

    Это поле выбрано по умолчанию.

    Если этот флажок установлен при создании изменения, изменение немедленно публикуется в Gerrit. Если флажок не установлен, изменение загружается в Gerrit, но не публикуется.

  4. Нажмите Создать .

    Изменение загружается в Gerrit. Если вы установили флажок «Опубликовать при создании» , изменение также будет опубликовано в Gerrit. Изменение связано с уведомлением в верхней части экрана.

    Изменить созданное уведомление

    Рисунок 6. Изменить созданное уведомление

Отслеживание утверждения изменений в Gerrit

Отслеживайте статус отправки изменений непосредственно в Gerrit, как и любые другие изменения.

Отслеживание статуса отправки изменений в Gerrit

Рисунок 7. Отслеживание статуса отправки изменений в Gerrit

Просмотр различий файлов

Установите флажок «Различия» под панелью редактирования, чтобы просмотреть различия в изменениях, внесенных вами в файл, активный на панели редактирования. Это полезно при изменении файла и при редактировании существующих изменений.

Просмотр различий файлов

Рисунок 8. Просмотр различий файлов

Восстановить файлы

Вы можете отменить изменения из одного файла или из всех файлов в списке ожидающих изменений. Обе опции возврата отменяют изменения только в редакторе исходного кода Git. Они НЕ будут обновлять изменения в Геррите.

Вернуть один файл

Чтобы отменить один файл, нажмите X рядом с именем файла в списке ожидающих изменений.

Раздел ожидающих изменений

Рисунок 9. Раздел ожидающих изменений

Восстановить все файлы

Чтобы восстановить все файлы одновременно, нажмите «Восстановить все файлы» под панелью редактирования.

Кнопка «Вернуть все файлы»

Рисунок 10. Кнопка «Вернуть все файлы»

Откроется всплывающее диалоговое окно. Нажмите «Отменить все» , чтобы отменить изменения во всех ожидающих файлах, или нажмите «Отмена» , чтобы сохранить изменения и продолжить редактирование.

Диалоговое окно подтверждения возврата всех файлов

Рисунок 11. Диалоговое окно подтверждения возврата всех файлов

Вы можете открыть файл в Git Source Editor прямо из поиска кода Android . Это полезно, если вам нужно найти файл перед его редактированием.

Следуйте этой процедуре, чтобы редактировать файл непосредственно из поиска кода Android.

  1. В поиске кода Android (cs.android.com) перейдите к файлу, который вы хотите редактировать.

  2. Нажмите «Изменить код» .

    Кнопка поиска кода Android «Изменить код»

    Рис. 12. Кнопка редактирования кода поиска кода Android

    Редактор исходного кода Git открывается с файлом, предварительно выбранным для редактирования.

  3. В раскрывающемся списке «Выберите ветку git » выберите ветку Git, в которой вы хотите редактировать файл, затем нажмите «Выбрать ветку» .

    Выбор ветки Git для редактирования

    Рисунок 13. Выбор ветки Git для редактирования

    Файл откроется в области редактирования.

  4. Продолжайте редактирование, как описано в разделе «Внесение изменений» .

  5. Вы можете открыть дополнительные файлы для редактирования, как описано в разделе «Загрузка файлов».

Разрешение конфликтов

Для разрешения конфликтов:

  1. В редакторе исходного кода перейдите к изменению. После загрузки изменения конфликтующие файлы отображаются в нижней части экрана. Например, на рисунке 14 показано, что файл Android.pb имеет конфликт.

    Конфликт редактора исходного кода

    Рисунок 14. Конфликт редактора исходного кода

  2. Щелкните конфликтующий файл. Файл последовательно загружает и отображает конфликтующие блоки контента внутри маркеров Git ( <<<<<<< и >>>>>>> ).

    Маркеры конфликта

    Рисунок 15. Маркеры конфликта редактора исходного кода

  3. Устраните конфликт, отредактировав файл и вручную удалив маркеры конфликта вокруг содержимого, которое вы хотите сохранить. Кроме того, удалите маркеры контента и конфликта для контента, который вы не хотите сохранять.

  4. Нажмите «Создать изменение» , чтобы создать новое изменение. Появится диалоговое окно «Создать изменение».

    Создать изменение

    Рисунок 16. Создание изменений

  5. Введите описание изменения и нажмите «Создать» .

Отправить отзыв

Используйте кнопку ошибки Изображение кнопки ошибки в правом верхнем углу, чтобы оставить отзыв о редакторе исходного кода Git.