aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Bennée <alex.bennee@linaro.org>2023-08-29 17:15:20 +0100
committerAlex Bennée <alex.bennee@linaro.org>2023-08-30 14:57:44 +0100
commit4b77429adbecf970d0ebb7213b99b82771b6368f (patch)
treea3ffd1653d483435ab1b258fe4fc63604aac6ed5 /docs
parentbb16cb45192b344c8bd5e3c2f423b96fb438ed29 (diff)
downloadqemu-4b77429adbecf970d0ebb7213b99b82771b6368f.zip
qemu-4b77429adbecf970d0ebb7213b99b82771b6368f.tar.gz
qemu-4b77429adbecf970d0ebb7213b99b82771b6368f.tar.bz2
docs/style: permit inline loop variables
I've already wasted enough of my time debugging aliased variables in deeply nested loops. While not scattering variable declarations around is a good aim I think we can make an exception for stuff used inside a loop. Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Acked-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Thomas Huth <thuth@redhat.com> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20230829161528.2707696-5-alex.bennee@linaro.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/devel/style.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/devel/style.rst b/docs/devel/style.rst
index 3cfcdeb..2f68b50 100644
--- a/docs/devel/style.rst
+++ b/docs/devel/style.rst
@@ -204,7 +204,14 @@ Declarations
Mixed declarations (interleaving statements and declarations within
blocks) are generally not allowed; declarations should be at the beginning
-of blocks.
+of blocks. To avoid accidental re-use it is permissible to declare
+loop variables inside for loops:
+
+.. code-block:: c
+
+ for (int i = 0; i < ARRAY_SIZE(thing); i++) {
+ /* do something loopy */
+ }
Every now and then, an exception is made for declarations inside a
#ifdef or #ifndef block: if the code looks nicer, such declarations can