[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 02/13] CODING_STYLE: specify the indent rule for mult
From: |
Laurent Vivier |
Subject: |
[Qemu-devel] [PULL 02/13] CODING_STYLE: specify the indent rule for multiline code |
Date: |
Thu, 2 May 2019 20:58:24 +0200 |
From: Wei Yang <address@hidden>
We didn't specify the indent rule for multiline code here, which may
mislead users. And in current code, the code use various styles.
Add this rule in CODING_STYLE to make sure this is clear to every one.
Signed-off-by: Wei Yang <address@hidden>
Suggested-by: Igor Mammedov <address@hidden>
Reviewed-by: Igor Mammedov <address@hidden>
Reviewed-by: Stefano Garzarella <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Laurent Vivier <address@hidden>
---
CODING_STYLE | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/CODING_STYLE b/CODING_STYLE
index ec075dedc4a8..90321e9c2821 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -29,6 +29,45 @@ Spaces of course are superior to tabs because:
Do not leave whitespace dangling off the ends of lines.
+1.1 Multiline Indent
+
+There are several places where indent is necessary:
+
+ - if/else
+ - while/for
+ - function definition & call
+
+When breaking up a long line to fit within line width, we need a proper indent
+for the following lines.
+
+In case of if/else, while/for, align the secondary lines just after the
+opening parenthesis of the first.
+
+For example:
+
+ if (a == 1 &&
+ b == 2) {
+
+ while (a == 1 &&
+ b == 2) {
+
+In case of function, there are several variants:
+
+ * 4 spaces indent from the beginning
+ * align the secondary lines just after the opening parenthesis of the
+ first
+
+For example:
+
+ do_something(x, y,
+ z);
+
+ do_something(x, y,
+ z);
+
+ do_something(x, do_another(y,
+ z));
+
2. Line width
Lines should be 80 characters; try not to make them longer.
--
2.20.1
- [Qemu-devel] [PULL 01/13] hw/net/pcnet: Use qemu_log_mask(GUEST_ERROR) instead of printf, (continued)
- [Qemu-devel] [PULL 01/13] hw/net/pcnet: Use qemu_log_mask(GUEST_ERROR) instead of printf, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 08/13] Update configure, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 04/13] Clean up includes, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 05/13] doc: fix the configuration path, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 11/13] Makefile: Let the 'clean' rule remove qemu-ga.exe on Windows hosts, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 09/13] Header cleanups, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 10/13] net: Print output of "-net nic, model=help" to stdout instead of stderr, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 03/13] CODING_STYLE: indent example code as all others, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 07/13] configure: fix pam test warning, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 12/13] hw/sparc/leon3: Allow load of uImage firmwares, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 02/13] CODING_STYLE: specify the indent rule for multiline code,
Laurent Vivier <=
- [Qemu-devel] [PULL 06/13] qom: use object_new_with_type in object_new_with_propv, Laurent Vivier, 2019/05/02
- [Qemu-devel] [PULL 13/13] sockets: avoid string truncation warnings when copying UNIX path, Laurent Vivier, 2019/05/02
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Peter Maydell, 2019/05/03
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Laurent Vivier, 2019/05/03
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Alex Bennée, 2019/05/03
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Markus Armbruster, 2019/05/08
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Alex Bennée, 2019/05/08
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Markus Armbruster, 2019/05/09
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Peter Maydell, 2019/05/09
- Re: [Qemu-devel] [PULL 00/13] Trivial branch patches, Markus Armbruster, 2019/05/10