fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-20 04:40:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Thomas Haller 2020-08-05 09:56:02 +02:00
parent 6c6a00eae5
commit 26d768a2b6
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING
View file

@ -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_log() message. NetworkManager won't use these levels for regular logging
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