From: Daan De Meyer Date: Thu, 14 Mar 2024 09:18:27 +0000 (+0100) Subject: docs: Update HACKING guide with recommended git config X-Git-Tag: v256-rc1~504 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c735424908fc44a633eac43036b02df8cb5272a9;p=thirdparty%2Fsystemd.git docs: Update HACKING guide with recommended git config --- diff --git a/docs/HACKING.md b/docs/HACKING.md index 1fbbed91d11..ac4d6a69b04 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/`,