diff options
| author | Bartosz Duszel <bartosz.duszel@protonmail.com> | 2020-03-22 13:50:58 +0100 |
|---|---|---|
| committer | Bartosz Duszel <bartosz.duszel@protonmail.com> | 2020-03-22 13:50:58 +0100 |
| commit | fd6a35eb59f1d8bce6afc773d0c44937326e0034 (patch) | |
| tree | 5b2f0d92fc15fa9b99dfb716fed9344dd4f60776 /doc/HACKING/CodingStandards.md | |
| parent | dccac40e6998a63894823c0ca3f8ea9c21ef8f18 (diff) | |
| download | tor-fd6a35eb59f1d8bce6afc773d0c44937326e0034.tar.gz tor-fd6a35eb59f1d8bce6afc773d0c44937326e0034.zip | |
Update README files with common style.
- external links use markdown's []() format,
- local files are formated with backquotes,
- duplicated new lines were removed,
- unnecesary single spaces were removed,
- broken links and local paths were updated.
Diffstat (limited to 'doc/HACKING/CodingStandards.md')
| -rw-r--r-- | doc/HACKING/CodingStandards.md | 9 |
1 files changed, 2 insertions, 7 deletions
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md index 7999724166..bcb945befd 100644 --- a/doc/HACKING/CodingStandards.md +++ b/doc/HACKING/CodingStandards.md @@ -34,7 +34,7 @@ Did you remember... 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 + - Set up Chutney and Stem, see `.../doc/HACKING/WritingTests.md` - Run `make test-full` to test against all unit and integration tests. If you have changed build system components: @@ -42,7 +42,6 @@ If you have changed build system components: - For example, if you have changed Makefiles, autoconf files, or anything else that affects the build system. - License issues ============== @@ -58,7 +57,6 @@ Some compatible licenses include: - 2-clause BSD - CC0 Public Domain Dedication - How we use Git branches ======================= @@ -91,7 +89,6 @@ conflicts in the ChangeLog when it comes time to merge your branch into Tor. Best advice: don't try to keep an independent branch forked for more than 6 months and expect it to merge cleanly. Try to merge pieces early and often. - How we log changes ================== @@ -250,7 +247,6 @@ available containers in `src/lib/containers/*.h`. You should probably familiarize yourself with these modules before you write too much code, or else you'll wind up reinventing the wheel. - We don't use `strcat` or `strcpy` or `sprintf` of any of those notoriously broken old C functions. We also avoid `strncat` and `strncpy`. Use `strlcat`, `strlcpy`, or `tor_snprintf/tor_asprintf` instead. @@ -281,7 +277,6 @@ version prefixed with `tor_` instead: strtok_r, memmem, memstr, asprintf, localtime_r, gmtime_r, inet_aton, inet_ntop, inet_pton, getpass, ntohll, htonll. (This list is incomplete.) - What code can use what other code? ---------------------------------- @@ -424,7 +419,7 @@ do your own profiling to determine otherwise. Log conventions --------------- -`https://www.torproject.org/docs/faq#LogLevel` +[FAQ - Log Levels](https://www.torproject.org/docs/faq#LogLevel) No error or warning messages should be expected during normal OR or OP operation. |