Verified Commit 26d768a2 authored by Thomas Haller's avatar Thomas Haller
Browse files

contributing: add section about our git-notes refs/notes/bugs

parent 6c6a00ea
Pipeline #186424 passed with stages
in 26 minutes and 49 seconds
...@@ -118,3 +118,28 @@ For testing, you also want to run NetworkManager with environment variable ...@@ -118,3 +118,28 @@ For testing, you also want to run NetworkManager with environment variable
G_DEBUG=fatal-warnings to crash upon G_LOG_LEVEL_CRITICAL and G_LOG_LEVEL_WARNING G_DEBUG=fatal-warnings to crash upon G_LOG_LEVEL_CRITICAL and G_LOG_LEVEL_WARNING
g_log() message. NetworkManager won't use these levels for regular logging g_log() message. NetworkManager won't use these levels for regular logging
but for assertions. but for assertions.
Git Notes (refs/notes/bugs)
---------------------------
There are special notes to annotate git commit messages with information
about "Fixes" and "cherry picked from". Annotating the history is useful
if it was not done initially because our scripts can make use of it.
The notes it are called "refs/notes/bugs".
So configure:
$ git config --add 'remote.origin.fetch' 'refs/notes/bugs:refs/notes/bugs'
$ git config --add 'notes.displayref' 'refs/notes/bugs'
For example, set notes with
$ git notes --ref refs/notes/bugs add -m "(cherry picked from $COMMIT_SHA)" HEAD
You should see the notes in git-log output as well.
To resync our local notes use:
$ git fetch origin refs/notes/bugs:refs/notes/bugs -f
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment