[trafficserver] branch 9.1.x updated: Note YAML parser library bug, and work-around, in documentation. (#7963)

[zw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zwoop pushed a commit to branch 9.1.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/9.1.x by this push:
     new 0ba98d6  Note YAML parser library bug, and work-around, in documentation. (#7963)
0ba98d6 is described below

commit 0ba98d600a746ef872de89402037b90ed8cafe8e
Author: Walt Karas <wk...@verizonmedia.com>
AuthorDate: Mon Jun 21 18:13:01 2021 -0500

    Note YAML parser library bug, and work-around, in documentation. (#7963)
    
    (cherry picked from commit dbc4f8e0bbfc5094d315b77857ddc5f38e04efa7)
---
 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 179c68e..9925ec2 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 **#**.