diff options
| author | Viktor Szakats <commit@vszakats.net> | 2019-05-16 22:11:27 +0000 |
|---|---|---|
| committer | Viktor Szakats <commit@vszakats.net> | 2019-05-16 22:11:27 +0000 |
| commit | f3e0f071b14fcb46a453f69bdf4e062bcaacf362 (patch) | |
| tree | 37baa141fb49de9959ba36bd49b1422293b5c3fb /docs/CODE_STYLE.md | |
| parent | 196ae6040261717ad8a1f24f363ebf119e509da8 (diff) | |
docs: Markdown and misc improvements [ci skip]
Approved-by: Daniel Stenberg
Closes #3896
Diffstat (limited to 'docs/CODE_STYLE.md')
| -rw-r--r-- | docs/CODE_STYLE.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/CODE_STYLE.md b/docs/CODE_STYLE.md index 2d275cd7d..0ceb5b9ad 100644 --- a/docs/CODE_STYLE.md +++ b/docs/CODE_STYLE.md @@ -9,8 +9,8 @@ style is more important than individual contributors having their own personal tastes satisfied. Our C code has a few style rules. Most of them are verified and upheld by the -"lib/checksrc.pl" script. Invoked with "make checksrc" or even by default by -the build system when built after "./configure --enable-debug" has been used. +`lib/checksrc.pl` script. Invoked with `make checksrc` or even by default by +the build system when built after `./configure --enable-debug` has been used. It is normally not a problem for anyone to follow the guidelines, as you just need to copy the style already used in the source code and there are no @@ -227,7 +227,7 @@ Align with the "current open" parenthesis: Use **#ifdef HAVE_FEATURE** to do conditional code. We avoid checking for particular operating systems or hardware in the #ifdef lines. The HAVE_FEATURE shall be generated by the configure script for unix-like systems and they are -hard-coded in the config-[system].h files for the others. +hard-coded in the `config-[system].h` files for the others. We also encourage use of macros/functions that possibly are empty or defined to constants when libcurl is built without that feature, to make the code |