From 968c71ba79fce08c8383ff9ee6fc75b4e0a1ddef Mon Sep 17 00:00:00 2001
From: h7x4 <h7x4@nani.wtf>
Date: Sun, 9 Nov 2025 20:14:10 +0900
Subject: [PATCH] example-config.toml: improve comments, default runtimedir to
 `/run`

---
 example-config.toml | 29 +++++++++++++++++++----------
 1 file changed, 19 insertions(+), 10 deletions(-)

diff --git a/example-config.toml b/example-config.toml
index c2f9e44..70c425c 100644
--- a/example-config.toml
+++ b/example-config.toml
@@ -1,22 +1,31 @@
 # This should go to `/etc/mysqladm/config.toml`
 
 [server]
-# Note that this gets ignored if you are using socket activation.
-socket_path = "/var/run/mysqladm/mysqladm.sock"
+# The path to the socket where users can connect to the daemon.
+#
+# Note that this options gets ignored if you are using systemd socket activation
+# (see `systemctl status mysqladm.socket`)
+socket_path = "/run/mysqladm/mysqladm.sock"
 
 [mysql]
 
-# if you use a socket, the host and port will be ignored
-# socket_path = "/var/run/mysql/mysql.sock"
-
+# Hostname and port of the database.
 host = "localhost"
 port = 3306
 
-# The username and password can be omitted if you are using
-# socket based authentication. However, the vendored systemd
-# service is running as DynamicUser, so by default you need
-# to at least specify the username.
+# The path to the unix socket of the databse.
+# If you uncomment this line, the host and port will be ignored
+
+# socket_path = "/run/mysql/mysql.sock"
+
+# The username and password for the database connection.
+# The username and password can be omitted if you are connecting
+# to the database using socket based authentication.
+# However, the vendored systemd service is running as DynamicUser,
+# so these need to be specified by default unless you override the
+# systemd unit.
 username = "root"
 password = "secret"
 
-timeout = 2 # seconds
\ No newline at end of file
+# Database connection timeout in seconds
+timeout = 2