Subject: Re: [PATCH v1 01/25] structured-logging: design document

From: Simon Ruderich <[email-masked]>
Date: Sat, 14 Jul 2018 10:34:01 +0200

On Fri, Jul 13, 2018 at 04:55:57PM +0000, [email-masked] wrote:
> diff --git a/Documentation/technical/structured-logging.txt b/Documentation/technical/structured-logging.txt
> new file mode 100644
> index 0000000..794c614
> --- /dev/null
> +++ b/Documentation/technical/structured-logging.txt
> @@ -0,0 +1,816 @@
> [snip]
>
> +"event": "cmd_start"
> +-------------------
> +
> +The "cmd_start" event is emitted when git starts when cmd_main() is
> +called.  In addition to the F1 fields, it contains the following
> +fields (F2):
> +
> +    "argv"        : <array-of-command-line-arguments>
> +
> +<argv> is an array of the original command line arguments given to the
> +    command (before git.c has a chance to remove the global options
> +    before the verb.

Missing closing parentheses.

> [snip]
>
> +<slog_{detail,timers,aux}> are the values of the corresponding
> +    "slog.{detail,timers,aux}" config setting.  Since these values
> +    control optional SLOG features and filtering, these are present
> +    to help post-processors know if an expected event did not happen
> +    or was simply filtered out.  (Described later)

Please write out "slog_detail, "slog_timers", etc. Using the
abbreviated forms makes searching a pain.

Regards
Simon
-- 
+ privacy is necessary
+ using gnupg http://gnupg.org
+ public key id: 0x92FEFDB7E44C32F9