conf: enhance app.ini comments

1 files changed, 25 insertions, 19 deletions

diff --git a/conf/app.ini b/conf/app.ini
index 6106b466..c4a5033c 100644
--- a/conf/app.ini
+++ b/conf/app.ini
@@ -2,7 +2,7 @@
 # !!! PLEASE MAKE CHANGES ON CORRESPONDING CUSTOM CONFIG FILE !!!
 # !!! IF YOU ARE PACKAGING PROVIDER, PLEASE MAKE OWN COPY OF IT !!!
 
-; The brand name of the application.
+; The brand name of the application, can be your company or team name.
 BRAND_NAME = Gogs
 ; The system user who should be running the applications. It has no effect on Windows,
 ; otherwise, it should match the value of $USER environment variable.
@@ -302,16 +302,17 @@ DISABLE_GRAVATAR = false
 ENABLE_FEDERATED_AVATAR = false
 
 [markdown]
-; Enable hard line break extension
+; Whether to enable hard line break extension.
 ENABLE_HARD_LINE_BREAK = false
-; List of custom URL-Schemes that are allowed as links when rendering Markdown
-; for example git,magnet
+; The list of custom URL schemes that are allowed as links when rendering Markdown.
+; For example, "git" (for "git://") and "magnet" (for "magnet://").
 CUSTOM_URL_SCHEMES =
-; List of file extensions that should be rendered/edited as Markdown
-; Separate extensions with a comma. To render files w/o extension as markdown, just put a comma
+; The list of file extensions that should be rendered/edited as Markdown.
+; Separate extensions with a comma. To render files with no extension as markdown, just put a comma.
 FILE_EXTENSIONS = .md,.markdown,.mdown,.mkd
 
 [smartypants]
+; Whether to enable the Smartypants extension.
 ENABLED = false
 FRACTIONS = true
 DASHES = true
@@ -319,23 +320,24 @@ LATEX_DASHES = true
 ANGLED_QUOTES = true
 
 [admin]
-; Disable regular (non-admin) users to create organizations
+; Whether to disable regular (non-admin) users to create organizations.
 DISABLE_REGULAR_ORG_CREATION = false
 
 [webhook]
-; Types are enabled for users to use, can be "gogs", "slack", "discord", "dingtalk"
+; The list of enabled types for users to use, can be "gogs", "slack", "discord", "dingtalk".
 TYPES = gogs, slack, discord, dingtalk
-; Deliver timeout in seconds
+; Deliver timeout in seconds.
 DELIVER_TIMEOUT = 15
-; Allow insecure certification
+; Whether to allow insecure certification.
 SKIP_TLS_VERIFY = false
-; Number of history information in each page
+; The number of history information in each page.
 PAGING_NUM = 10
 
-; General settings of loggers
+; General settings of loggers.
 [log]
+; The root path for all log files, default is "log/" subdirectory.
 ROOT_PATH =
-; Can be "console" and "file", default is "console"
+; Can be "console", "file", "slack" and "discord".
 ; Use comma to separate multiple modes, e.g. "console, file"
 MODE = console
 ; Buffer length of channel, keep it as it is if you don't know what it is.
@@ -352,15 +354,15 @@ LEVEL = Trace
 [log.file]
 ; Comment out to inherit
 ; LEVEL =
-; This enables automated log rotate (switch of following options)
+; Whether to enable automated log rotate (switch of following options).
 LOG_ROTATE = true
-; Segment log daily
+; Whether to segment log files daily.
 DAILY_ROTATE = true
-; Max size shift of single file, default is 28 means 1 << 28, 256MB
+; The maximum size shift of single file, default is 28 means 1 << 28 = 256MB.
 MAX_SIZE_SHIFT = 28
-; Max line number of single file
+; The maximum number of lines of single file.
 MAX_LINES = 1000000
-; Expired days of log file (delete after max days)
+; The expired days of log file (delete after max days).
 MAX_DAYS = 7
 
 ; For "slack" mode only
@@ -375,7 +377,7 @@ URL =
 ; LEVEL =
 ; Webhook URL
 URL =
-; Username displayed in webhook
+; The username to be displayed in notification.
 USERNAME = %(BRAND_NAME)s
 
 [log.xorm]
@@ -480,9 +482,13 @@ NEWS_FEED_PAGING_NUM = 20
 COMMITS_PAGING_NUM = 30
 
 [prometheus]
+; Whether to enable Prometheus metrics.
 ENABLED = true
+; Whether to enable HTTP Basic Authentication to protect metrics data.
 ENABLE_BASIC_AUTH = false
+; The username for HTTP Basic Authentication.
 BASIC_AUTH_USERNAME =
+; The password for HTTP Basic Authentication.
 BASIC_AUTH_PASSWORD =
 
 ; Extension mapping to highlight class