From a3871e62a773f7f52c15b90cb009a7ec4a64cc48 Mon Sep 17 00:00:00 2001 From: Frediano Ziglio Date: Wed, 11 May 2016 10:28:13 +0100 Subject: [PATCH] style: we are now using capital FIXME and TODO Signed-off-by: Frediano Ziglio Acked-by: Pavel Grunt --- docs/spice_style.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/spice_style.txt b/docs/spice_style.txt index 89663652..e4328fcf 100644 --- a/docs/spice_style.txt +++ b/docs/spice_style.txt @@ -59,10 +59,10 @@ Static storage initialization To improve code readability, explicitly initialize variables that depend on default initialization with zero/null. -Fixme and todo +FIXME and TODO -------------- -Comments that are prefixed with `fixme` describe a bug that need to be fixed. Generally, it is not allowed to commit new code having `fixme` comment. Committing `fixme` is allowed only for existing bugs. Comments that are prefixed with `todo` describe further features, optimization or code improvements, and they are allowed to be committed along with the relevant code. +Comments that are prefixed with `FIXME` describe a bug that need to be fixed. Generally, it is not allowed to commit new code having `FIXME` comment. Committing `FIXME` is allowed only for existing bugs. Comments that are prefixed with `TODO` describe further features, optimization or code improvements, and they are allowed to be committed along with the relevant code. ASSERT ------