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
|
#!/bin/bash
# find everything that looks like
# {"driver", YAML_SCALAR_NODE,...,
# extract the thing in quotes.
# coherence check: make sure none have disappeared, as might happen from a reformat.
count=$(sed -n 's/[ ]\+{"\([a-z0-9-]\+\)", YAML_[A-Z]\+_NODE.*/\1/p' src/parse.c | sort | wc -l)
# 144 is based on 0.99+da6f776 definitions, and should be updated periodically.
if [ $count -lt 202 ]; then
echo "ERROR: fewer YAML keys defined in src/parse.c than expected!"
echo " Has the file been reformatted or refactored? If so, modify"
echo " validate_docs.sh appropriately."
exit 1
fi
# iterate through the keys
for term in $(sed -n 's/[ ]\+{"\([a-z0-9-]\+\)", YAML_[A-Z]\+_NODE.*/\1/p' src/parse.c | sort | uniq); do
# it can be documented in the following ways.
# 1. "Properties for device type `blah:`
if egrep "## Properties for device type \`$term:\`" doc/netplan-yaml.md > /dev/null; then
continue
fi
# 2. "[blah, ]**blah**[, **blah2**]: (scalar|bool|...)
if egrep "Alias: \*\*$term\*\*|\*\*$term\*\*.*\((scalar|bool|mapping|sequence of scalars|sequence of mappings|sequence of sequence of scalars)" doc/netplan-yaml.md > /dev/null; then
continue
fi
# 3. we give a pass to network and version
if [[ $term = "network" ]] || [[ $term = "version" ]]; then
continue
fi
# 4. search doesn't get a full description but it's good enough
if [[ $term = "search" ]]; then
continue
fi
# 5. gratuit_i_ous arp gets a special note
if [[ $term = "gratuitious-arp" ]]; then
continue
fi
echo ERROR: The key "$term" is defined in the parser but not documented.
exit 1
done
echo "validate_docs: OK"
|
