From 41cbea29b404616bbd2b6f22eb269bbc83ac9fb4 Mon Sep 17 00:00:00 2001
From: Eli Schwartz <eschwartz@archlinux.org>
Date: Wed, 18 Jul 2018 23:01:36 -0400
Subject: doc: declare what type of comments we support in pacman.conf

Ini-style configuration formats are all over the place. So are we, for
that matter, as we switched how we treated middle-of-line comments in
commit 8a19c4a78251c5e34ecf508a65d943ca2dc833c7 -- namely, they're not
comments anymore. This is surprising to users, who report bugs because
it used to work, but what's more surprising is that the only
"documentation" for the type of comments users can be expected to use,
is by guessing from our example pacman.conf and maybe discovering
unreliable easter eggs.

Fixes FS#58809

Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
Signed-off-by: Allan McRae <allan@archlinux.org>
---
 doc/pacman.conf.5.asciidoc | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'doc/pacman.conf.5.asciidoc')

diff --git a/doc/pacman.conf.5.asciidoc b/doc/pacman.conf.5.asciidoc
index e5fffecf..5f9def5b 100644
--- a/doc/pacman.conf.5.asciidoc
+++ b/doc/pacman.conf.5.asciidoc
@@ -19,6 +19,9 @@ Each section defines a package repository that pacman can use when searching
 for packages in '\--sync' mode. The exception to this is the options section,
 which defines global options.
 
+Comments are only supported by beginning a line with the hash (#) symbol.
+Comments cannot begin in the middle of a line.
+
 
 Example
 -------
-- 
cgit v1.2.3-70-g09d2

