summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormpeter50 <83356418+mpeter50@users.noreply.github.com>2022-10-27 08:47:19 +0000
committerGitHub <noreply@github.com>2022-10-27 16:47:19 +0800
commit10b850602349782697a1b0dbbb93fa63cb8b372f (patch)
tree334dc94a10ebe2874da8e4a3c4ca43d881c12508
parent096aed5c1d4bf5d431306474b1410d35db8a231a (diff)
downloadgitea-10b850602349782697a1b0dbbb93fa63cb8b372f.tar.gz
gitea-10b850602349782697a1b0dbbb93fa63cb8b372f.zip
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 <xiaolunwen@gmail.com>
-rw-r--r--docs/content/doc/advanced/config-cheat-sheet.en-us.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
index 3fd853fb14..ebc860c457 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
@@ -810,9 +810,9 @@ Default templates for project boards:
- `STACKTRACE_LEVEL`: **log.STACKTRACE_LEVEL**: Sets the log level at which to log stack traces.
- `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.
- `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.
-- `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.
+- `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.
- `PREFIX`: **""**: An additional prefix for every log line in this logger. Defaults to empty.
-- `COLORIZE`: **false**: Colorize the log lines by default
+- `COLORIZE`: **false**: Whether to colorize the log lines
### Console log mode (`log.console`, `log.console.*`, or `MODE=console`)