From 3c91ea49d249cda6e1fa84b53a42dee6d83339da Mon Sep 17 00:00:00 2001 From: Mike Yuan Date: Tue, 2 Jul 2024 19:20:01 +0200 Subject: [PATCH] docs/CODING_STYLE: document that we nowadays prefer (const char*) for func ret type Addresses https://github.com/systemd/systemd/pull/33567#discussion_r1662818225 (cherry picked from commit 4b7249111a4c1d366f476bdbd6e03f7893eb9d42) --- docs/CODING_STYLE.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md index 309436a397..82ed0a553c 100644 --- a/docs/CODING_STYLE.md +++ b/docs/CODING_STYLE.md @@ -54,6 +54,18 @@ SPDX-License-Identifier: LGPL-2.1-or-later } ``` +- Function return types should be seen/written as whole, i.e. write this: + + ```c + const char* foo(const char *input); + ``` + + instead of this: + + ```c + const char *foo(const char *input); + ``` + - Single-line `if` blocks should not be enclosed in `{}`. Write this: ```c @@ -182,7 +194,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later ```c static int foobar_frobnicate( - Foobar* object, /* the associated mutable object */ + Foobar *object, /* the associated mutable object */ const char *input, /* immutable input parameter */ char **ret_frobnicated, /* return parameter on success */ unsigned *reterr_line, /* return parameter on failure */ -- 2.25.1