Document comment feature

This commit is contained in:
Jordan Sissel 2012-08-16 11:49:01 -07:00
parent bf2f49313a
commit 05d80fafea

View file

@ -11,6 +11,8 @@ configurations for each plugin available in that section.
Example:
# This is a comment. You should use comments to describe
# parts of your configuration.
input {
...
}
@ -23,10 +25,16 @@ Example:
...
}
## Filters
## Filters and Ordering
For a given event, are applied in the order of appearance in the config file.
## Comments
Comments are as in ruby, perl, and python. Starts with a '#' character. Example:
# this is a comment
## Value Types
The documentation for a plugin may say that a config field has a certain type.