aboutsummaryrefslogtreecommitdiff
path: root/doc/HACKING/CodingStandards.md
diff options
context:
space:
mode:
authorChelsea H. Komlo <chelsea.komlo@gmail.com>2017-07-09 16:17:21 -0400
committerChelsea H. Komlo <chelsea.komlo@gmail.com>2017-07-09 16:17:21 -0400
commit934f85f87aa17bf6e1ffad37df8d8d4fb7bf404e (patch)
tree57fac480f915fe997c41b72707438d5a4c28dc7e /doc/HACKING/CodingStandards.md
parent24d29c7ae0c523da7d59495438bbea10114da5e1 (diff)
downloadtor-934f85f87aa17bf6e1ffad37df8d8d4fb7bf404e.tar.gz
tor-934f85f87aa17bf6e1ffad37df8d8d4fb7bf404e.zip
specify when to run make distcheck
Diffstat (limited to 'doc/HACKING/CodingStandards.md')
-rw-r--r--doc/HACKING/CodingStandards.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md
index da8ce62f5e..cc1ba8e773 100644
--- a/doc/HACKING/CodingStandards.md
+++ b/doc/HACKING/CodingStandards.md
@@ -7,7 +7,7 @@ tl;dr:
- Document your functions
- Write unit tests
- Run `make check` before submitting a patch
- - Run `make distcheck` to ensure the distribution works
+ - Run `make distcheck` if you have made changes to build system components
- Add a file in `changes` for your branch.
Patch checklist
@@ -37,6 +37,11 @@ If you are submitting a major patch or new feature, or want to in the future...
- Set up Chutney and Stem, see HACKING/WritingTests.md
- Run `make test-full` to test against all unit and integration tests.
+If you have changed build system components:
+ - Please run `make distcheck`
+ - For example, if you have changed Makefiles, autoconf files, or anything
+ else that impacts the build system.
+
How we use Git branches
=======================