From 00a2126152e8d545bdb84956f9a999f10a487934 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Thu, 28 Mar 2019 08:08:21 +0530 Subject: [PATCH] Document the comments syntax for config files Fixes #1503 --- docs/conf.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/conf.rst b/docs/conf.rst index 574f26ea9..c7f99ecfe 100644 --- a/docs/conf.rst +++ b/docs/conf.rst @@ -20,6 +20,10 @@ You can also display the current configuration by running ``kitty :option:`kitty --config` option or use the ``KITTY_CONFIG_DIRECTORY`` environment variable. See the :option:`kitty --config` option for full details. +Comments can be added to the config file as lines starting with the ``#`` +character. This works only if the ``#`` character is the first character +in the line. + You can include secondary config files via the :code:`include` directive. If you use a relative path for include, it is resolved with respect to the location of the current config file. Note that environment variables are