multiple errors and unclarities in Reference manual
Antonio
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=252677
Note: the problems are still seen in 2.2.9
---
The following sections refer to anchors within the file
cfengine-Reference.html. Some of these are errors, and others are
just
points that aren't clear.
#Syntax:
(1) Some option values are listed in bold, but the manual doesn't say
why.
(2) The manual says that options can be abbreviated by any unique
abbreviation, but this isn't true at least for "action". As far as I
can can tell from the manual, "a" is a unique abbreviation for
"action",
but when I try to use "a" in place of "action", cfagent says "Illegal
file attribute". "ac" does work, however. Does this mean that
there's
another option that begins with "a", and which isn't documented in the
manual?
(3) "inform" is listed as an option but not documented.
(4) "xdev" is described in the summary as "xdev=true/on/false/off",
but
in the detailed description as just "xdev". Does this mean that I can
just mention "xdev" and this is equivalent to "xdev=true"? What about
for other true/false options?
#Directory%20permissions: in the example, "fixall" should be
"act=fixall".
#home%20directive: in the last example, "fixall" should be
"act=fixall".
#import: "you can use the include directive" should be "you can use
the
import directive".
#homepattern: "this is not presently possible." What exactly isn't
presently possible? Having elements of HomePattern with forward-
slashes
in them?
#Special%20variables:
(1) are special variable names case sensitive? Apparently not, but
the
manual doesn't say.
(2) the entry for "split" says "see the reference manual". This is
the
reference manual. A link to #split would be useful here.
#control: are control declarations case-sensitive? Apparently not,
but
the manual doesn't say.
#Variable%20Index: AllClasses isn't listed.
General:
(1) wildcards and patterns: these are frequently referred to (e.g. in
#Syntax: include=wildcard/pattern), but never defined, except
partially
in passing under #tidy and cfengine-Tutorial.html#Regular
%20expressions.
What is a wildcard? What is a pattern? Are they different?
(2) case sensitivity: I suggest adding a general declaration
somewhere,
linked to from other sections such as "control" and "special
variables",
of what things are case sensitive and what aren't.