-
Notifications
You must be signed in to change notification settings - Fork 0
/
warnings.txt
78 lines (63 loc) · 3 KB
/
warnings.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
List of warnings
================
[[Parent]]: user_documentation.txt
Remark generates various warnings that help in ensuring that no
document is accidentally left off linked, that every document
has a description, and that links are specified in a way that
promotes robustness. These warnings can be disabled one by one
by the `-d` option. Warnings which are specific to a given macro
are listed in the documentation of that macro.
General-purpose warnings
------------------------
ambiguous-document
: This warning is generated when a given path matches multiple documents
in the document-tree. To fix this, introduce more context to the path to
disambiguate the correct document in the document-tree.
ambiguous-input
: This warning is generated when facing input that is well-formed,
but ambiguous, for example, when giving multiple descriptions
for a given document. To fix this, remove some input to make
the choice unambiguous.
ambiguous-parent
: This warning is generated when there are multiple documents matching
a given parent-specification in the document-tree. To fix this, introduce
more context into the parent path to disambiguate the correct document
in the document-tree.
invalid-input
: This warning is generated when facing input that is ill-formed,
for example, when a macro gets too many or too few parameters.
To fix this, replace the ill-formed input with well-formed input.
missing-document
: This warning is generated when a document can not be found from the
document-tree based on the given path, for example, when specifying
images on an image gallery. To fix this, change the path to refer to
an existing document in the document-tree.
missing-parent
: This warning is generated when the specified parent document can not
be found from the document-tree. To fix this, change the parent-
specification to refer to an existing document in the document-tree.
redundant-path
: This warning is generated when specifying a path in a longer form
than is necessary for the file-searching algorithm to unambiguously
find the document. To fix this, remove the extraneous context from
the given path.
unspecified-parent
: This warning is generated when the parent document has not been
specified for a RemarkPage document. To fix this, specify the
parent document.
undefined-tag
: This warning is generated when trying to refer to a tag which
has not yet been defined. To fix this, either remove the reference or
add a definition for the tag.
undefined-variable
: This warning is generated when trying to refer to a variable which
has not yet been defined. To fix this, either remove the reference
or add a definition for the variable.
unknown-macro
: This warning is generated when invoking an unrecognized macro. To fix
this, define the macro, rename the invoked macro to a recognized one,
or remove the macro invocation.
quick
: This warning is generated when using the `-q` command-line option, to
remind that some documents may not be generated. To fix this, remove
the `-q` option.