Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.06 KB

development-setup.md

File metadata and controls

75 lines (49 loc) · 2.06 KB

Development Setup

State: Work-in-progress, last updated 2023-05-07

Table of Contents

  1. Git
  2. CLion

Git

We have a list of commits that can safely be ignored when doing a git blame. .git-blame-ignore-revs in MediaElch's project root contains a list of commits that we ignore. You can tell your local Git project to do the same with:

# See .git-blame-ignore-revs in project root
git config blame.ignoreRevsFile .git-blame-ignore-revs

Furthermore, since 2022-10-03, we try to use Conventional Commits. Because we sometimes forget what "commit types" there are, we have a default commit message template, that has some tips.

git config commit.template scripts/etc/git-default-commit-message.txt

History: We did not have any convention, but I mostly used [Type] Description, where Type was whatever I liked.

CLion

If you use CLion (by Jetbrains), you may want to have debugger renderers for Qt. Read the documentation for detailed setup steps. This worked for me ob Ubuntu 22.04:

gdb --version
# Should be >= 12

cd "$HOME/Projects" # Use your projects paths 
git clone --depth=1 --single-branch --branch=master https://github.com/KDE/kdevelop.git

In MediaElch/.gdbinit, I added:

python

import sys, os

p = '/path/to/kdevelop/plugins/gdb/printers/'

print(f".gdbinit Python: current working directory is {os.getcwd()}")
print(f".gdbinit Python: adding custom pretty-printers directory to the GDB path: {p}")

sys.path.insert(0, p)

end

source /path/to/kdevelop/plugins/gdb/printers/gdbinit

If the project specific .gdbinit doesn't work, see CLion's "configuring debugger options". I have adapted ~/.config/gdb/gdbinit with:

add-auto-load-safe-path /path/to/MediaElch/.gdbinit