Re: [PATCH 1/2] ACPI / EC: Cleanup logging/debugging splitter support.

[Joe Perches <joe@perches.com>]

On Fri, 2015-02-27 at 14:48 +0800, Lv Zheng wrote:
> This patch refines logging/debugging splitter support so that when DEBUG is
> disabled, splitters won't be visible in the kernel logs while they are
> still available for developers when DEBUG is enabled.
> 
> This patch also refines the splitters to mark the following handling
> process boundaries:
>   +++++: boundary of driver starting/stopping
>          boundary of IRQ storming
>   =====: boundary of transaction advancement
>   *****: boundary of EC command
>          boundary of EC query
>   #####: boundary of EC _Qxx evaluation

trivia:

> diff --git a/drivers/acpi/ec.c b/drivers/acpi/ec.c
[]
>  /* --------------------------------------------------------------------------
> + *                           Logging/Debugging
> + * -------------------------------------------------------------------------- */
> +
> +/*
> + * Splitters used by the developers to track the boundary of the EC
> + * handling processes.
> + */

It'd be nice to comment/document these 3 letter descriptions
a bit better here in the source code.

> +#ifdef DEBUG
> +#define EC_DBG_SEP	" "
> +#define EC_DBG_DRV	"+++++"
> +#define EC_DBG_STM	"====="
> +#define EC_DBG_REQ	"*****"
> +#define EC_DBG_EVT	"#####"

Maybe:

#define EC_DBG_SEP	" "
#define EC_DBG_DRV	"+++++"		/* drivers start/stop */
#define EC_DBG_STM	"====="		/* irq storm */
#define EC_DBG_REQ	"*****"		/* ec command boundary */
#define EC_DBG_EVT	"#####"		/* EC _Qxx evaluation */
>