diff options
author | Andrei Pavel <andrei@isc.org> | 2023-09-22 15:11:57 +0200 |
---|---|---|
committer | Andrei Pavel <andrei@isc.org> | 2023-09-22 15:12:08 +0200 |
commit | ff7851b3400ca65c8ef2b9e8e14b29bb31ad7933 (patch) | |
tree | 99fee5c678f374cea2756aadfa73dc79b069d61d /CONTRIBUTING.md | |
parent | [#1520] reset default flags on --enable-debug (diff) | |
download | kea-ff7851b3400ca65c8ef2b9e8e14b29bb31ad7933.tar.xz kea-ff7851b3400ca65c8ef2b9e8e14b29bb31ad7933.zip |
[#1520] add debug symbols section to dev guide
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8176e16b6..245ef11c8f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ Here's a quick list of how to contribute a patch: 2. **open an issue** in [Kea project](https://gitlab.isc.org/isc-projects/kea/issues/new), make sure it describes what you want to fix and **why** 3. **ask someone from the ISC team to give you permission to fork Kea** (ask @tomek, @vicky, @ondrej - or @godfryd or basically anyone from the Kea dev team) + or basically anyone from the Kea dev team) 4. **fork Kea code**: go to Kea project page, click [Fork button](https://gitlab.isc.org/isc-projects/kea/forks/new). If you can't, you didn't complete step 3. 5. **Implement your fix or feature, push code** to your repo. Make sure it compiles, has unit-tests, @@ -188,8 +188,9 @@ make distcheck There are other useful switches which can be passed to configure. It is always a good idea to use `–enable-logger-checks`, which does sanity checks on logger parameters. Use `–-enable-debug` to -enable various additional consistency checks that reduce performance but help during development. If -you happen to modify anything in the documentation, use `–-enable-generate-docs`. If you are +enable debug symbols and various additional consistency checks that reduce performance but help +during development. +If you happen to modify anything in the documentation, use `–-enable-generate-docs`. If you are modifying DHCP code, you are likely to be interested in enabling a non-default database backends for DHCP. Note that if the backend is not enabled, the database-specific unit-tests are skipped. To enable the MySQL backend, use the switch `–with-mysql`; for PostgreSQL, use `–with-pgsql`. @@ -216,7 +217,7 @@ particular, new users can't fork the code on their own and it requires someone f grant the ability to fork projects. Fortunately, this is easy to do and we glady do this for anyone who asks and provides a good reason. "I'd like to fix bug X or develop feature Y" is an excellent reason. The best place for asking is either kea-dev or asking in a comment in your issue. Make sure -you put a name tag (@tomek, @godfryd, @vicky or @ondrej). When you write a comment in an issue or +you put a name tag (@tomek, @vicky or @ondrej). When you write a comment in an issue or merge request and add a name tag on it, the user is automatically notified. Once you fork the Kea code in gitlab, you have your own copy and you can commit your changes there |