Описание тега git-notes

Описание тега Вопросы с тегом
Типичное использование git notes - дополнение сообщения о фиксации без изменения самой фиксации. Примечания могут отображаться в журнале git вместе с исходным сообщением о фиксации. Чтобы отличить эти примечания от сообщения, хранящегося в объекте фиксации, примечания имеют отступ, как и сообщение, после строки без отступа "Примечания (<refname>):"(или" Примечания:"для ссылок / примечаний / коммитов). </refname>

Когда файлы фиксируются в репозитории Git, к ним обращаются с помощью хэша содержимого. То же самое с деревьями и коммитами. Одним из преимуществ этой структуры является то, что объекты не могут быть изменены после того, как они были зафиксированы (поскольку это приведет к изменению этого хеша).

Однако иногда желательно иметь возможность добавлять метаданные в коммит после того, как он уже был зафиксирован. Это можно сделать тремя способами:

Измените сообщение фиксации, чтобы добавить дополнительные метаданные, принятие этого изменит ветку. Создайте узел слияния с более подробной фиксацией и нажмите ее (чтобы предыдущая фиксация была сохранена и могла быть быстро перенаправлена). Добавьте дополнительные метаданные в виде заметок git. Из этих трех вариантов только последний не изменит текущую ветку.

Git Notes - это, по сути, отдельная "ветвь" репозитория (хранящаяся в.git / refs / notes). Они не отображаются в команде git branch (по умолчанию в списке.git / refs / Heads). Однако, хотя вы можете проверить его и обновить вручную, есть команда, которая поможет вам в этом; git отмечает.

По умолчанию заметки сохраняются и читаются из ссылок / заметок / коммитов, но это значение по умолчанию можно изменить. См. Разделы "ОПЦИИ", "КОНФИГУРАЦИЯ" и "СРЕДА" ниже. Если этот ref не существует, он будет незаметно создан при первой необходимости для сохранения заметки.

Чтобы изменить, какие заметки отображаются в журнале git, см. Конфигурацию "notes.displayRef" в git-log.

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

   $ git notes add -m 'Tested-by: Rachel Gallen<rg@kdbg.net>' 72a144e2
   $ git show -s 72a144e
   [...]
         Signed-off-by: Ruth Escat<gitster@pobox.com>

   Notes:
         Tested-by: Rachel Gallen <rg@kdbg.net>

Источник