summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDaan De Meyer <daan.j.demeyer@gmail.com>2024-03-14 10:18:27 +0100
committerDaan De Meyer <daan.j.demeyer@gmail.com>2024-03-15 17:27:49 +0100
commitc735424908fc44a633eac43036b02df8cb5272a9 (patch)
tree5eaf1805c63720bd7544c5f4f944ad2747f35476 /docs
parentNEWS: mention portablectl --copy=mixed (diff)
downloadsystemd-c735424908fc44a633eac43036b02df8cb5272a9.tar.xz
systemd-c735424908fc44a633eac43036b02df8cb5272a9.zip
docs: Update HACKING guide with recommended git config
Diffstat (limited to 'docs')
-rw-r--r--docs/HACKING.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/HACKING.md b/docs/HACKING.md
index 1fbbed91d1..ac4d6a69b0 100644
--- a/docs/HACKING.md
+++ b/docs/HACKING.md
@@ -14,6 +14,14 @@ feature, please feel invited to fix it, and submit your work as a
Please make sure to follow our [Coding Style](CODING_STYLE) when submitting
patches. Also have a look at our [Contribution Guidelines](CONTRIBUTING).
+To start, run the following commands in the systemd git repository to set up
+git correctly:
+
+```shell
+$ git config submodule.recurse true
+$ git config fetch.recurseSubmodules on-demand
+```
+
When adding new functionality, tests should be added. For shared functionality
(in `src/basic/` and `src/shared/`) unit tests should be sufficient. The general
policy is to keep tests in matching files underneath `src/test/`,