From c4ee7437108e1d5522ccb39300de980db15eff13 Mon Sep 17 00:00:00 2001 From: Walter Karas Date: Mon, 21 Jun 2021 13:06:03 -0500 Subject: [PATCH] Note YAML parser library bug, and work-around, in documentation. --- doc/admin-guide/files/index.en.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/admin-guide/files/index.en.rst b/doc/admin-guide/files/index.en.rst index 179c68e1866..9925ec2eef0 100644 --- a/doc/admin-guide/files/index.en.rst +++ b/doc/admin-guide/files/index.en.rst @@ -86,3 +86,9 @@ Configuration Files :doc:`volume.config.en` Defines cache space usage by individual protocols. + +.. note:: + + Currently the YAML parsing library has a bug where line number counting + (for error messages) ignores comment lines that start with **#**. A + work-around is to put a space before the **#**.