Skip to content

Commit 10b8506

Browse files
mpeter50lunny
andauthored
Improve documentation (#21612)
Fix file reference at the FLAGS line at the Log subsections heading, improve COLORIZE line wording. The FLAGS line referenced a file that doesn't exist in the repository as of now. The COLORIZE line's wording implied that it would unconditionally colorize the log by default. Co-authored-by: Lunny Xiao <[email protected]>
1 parent 096aed5 commit 10b8506

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -810,9 +810,9 @@ Default templates for project boards:
810810
- `STACKTRACE_LEVEL`: **log.STACKTRACE_LEVEL**: Sets the log level at which to log stack traces.
811811
- `MODE`: **name**: Sets the mode of this sublogger - Defaults to the provided subsection name. This allows you to have two different file loggers at different levels.
812812
- `EXPRESSION`: **""**: A regular expression to match either the function name, file or message. Defaults to empty. Only log messages that match the expression will be saved in the logger.
813-
- `FLAGS`: **stdflags**: A comma separated string representing the log flags. Defaults to `stdflags` which represents the prefix: `2009/01/23 01:23:23 ...a/b/c/d.go:23:runtime.Caller() [I]: message`. `none` means don't prefix log lines. See `modules/log/base.go` for more information.
813+
- `FLAGS`: **stdflags**: A comma separated string representing the log flags. Defaults to `stdflags` which represents the prefix: `2009/01/23 01:23:23 ...a/b/c/d.go:23:runtime.Caller() [I]: message`. `none` means don't prefix log lines. See `modules/log/flags.go` for more information.
814814
- `PREFIX`: **""**: An additional prefix for every log line in this logger. Defaults to empty.
815-
- `COLORIZE`: **false**: Colorize the log lines by default
815+
- `COLORIZE`: **false**: Whether to colorize the log lines
816816

817817
### Console log mode (`log.console`, `log.console.*`, or `MODE=console`)
818818

0 commit comments

Comments
 (0)