From 794c1636ebb9e3e355b45b9f4fab006bdc0fc8c8 Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Fri, 16 Sep 2016 12:44:22 -0700 Subject: [PATCH] Add note to explain inline comments can only begin with ; (#17607) Fixes #16151 --- docsite/rst/intro_configuration.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index 0028dcd74a..d5506bd084 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -24,6 +24,16 @@ Prior to 1.5 the order was:: Ansible will process the above list and use the first file found. Settings in files are not merged. +.. note:: Comments + The configuration file is one variant of an INI format. Both the hash + sign ("#") and semicolon (";") are allowed as comment markers when the + comment starts the line. However, if the comment is inline with regular + values, only the semicolon is allowed to introduce the comment. For + instance:: + + # some basic default values... + inventory = /etc/ansible/hosts ; This points to the file that lists your hosts + .. _getting_the_latest_configuration: Getting the latest configuration