/
doc.go
58 lines (42 loc) · 1.05 KB
/
doc.go
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
// Copyright (c) 2020-2021, R.I. Pienaar and the Choria Project contributors
//
// SPDX-License-Identifier: Apache-2.0
package config
import (
"sort"
"github.com/choria-io/go-choria/confkey"
)
func (c *Config) overrideDocDescription(doc *confkey.Doc) *confkey.Doc {
if doc == nil {
return doc
}
desc, ok := docStrings[doc.ConfigKey()]
if ok {
doc.SetDescription(desc)
}
return doc
}
func (c *Config) DocForConfigKey(k string) *confkey.Doc {
doc := confkey.KeyDoc(c, k, "")
if doc != nil {
return c.overrideDocDescription(doc)
}
doc = confkey.KeyDoc(c.Choria, k, "Choria")
return c.overrideDocDescription(doc)
}
// ConfigKeys retrieves all known configuration keys matching re
func (c *Config) ConfigKeys(re string) (found []string, err error) {
found = []string{}
keys, err := confkey.FindFields(c, re)
if err != nil {
return found, err
}
found = append(found, keys...)
keys, err = confkey.FindFields(c.Choria, re)
if err != nil {
return found, err
}
found = append(found, keys...)
sort.Strings(found)
return found, nil
}