From f2478e9160de440158f296401979388e78f0eb66 Mon Sep 17 00:00:00 2001 From: Michael Schmoock Date: Thu, 5 Mar 2020 22:42:21 +0100 Subject: [PATCH] doc: point out 8char visual tabs in STYLE.md Changelog-None --- .editorconfig | 1 + doc/STYLE.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/.editorconfig b/.editorconfig index e2eb17b87..e49de5f5e 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,7 @@ trim_trailing_whitespace = true [{**.c,**.h,Makefile}] indent_style = tab +indent_size = 8 [**.py] indent_style = space diff --git a/doc/STYLE.md b/doc/STYLE.md index dd7b6fcdf..a805d2987 100644 --- a/doc/STYLE.md +++ b/doc/STYLE.md @@ -36,6 +36,22 @@ using early returns or continues, eg: } ``` +## Tabs and indentaion + +The C code uses TAB charaters with a visual indentation of 8 whitespaces. +If you submit code for a review, make sure your editor knows this. + +When breaking a line with more than 80 characters, align parameters and +arguments like so: + +```C +static void subtract_received_htlcs(const struct channel *channel, + struct amount_msat *amount) +``` + +Note: For more details, the files `.clang-format` and `.editorconfig` are +located in the projects root directory. + ## Prefer Simple Statements Notice the statement above uses separate tests, rather than combining