diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2021-02-16 17:49:55 -0700 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-02-16 17:49:55 -0700 |
commit | 310c483022c7e4af9eee4351f12c13e49e431f6c (patch) | |
tree | 4ae205c51876c49f533ea41a714c9860db61b768 /doc | |
parent | 4a163f43514211fb6f7b6df643d4868625ac065c (diff) | |
download | consfigurator-310c483022c7e4af9eee4351f12c13e49e431f6c.tar.gz |
prereq data check functions can't return t
That would overcomplicate choosing paths at which to cache data.
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guide.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/guide.rst b/doc/guide.rst index d8bf1b3..db15bba 100644 --- a/doc/guide.rst +++ b/doc/guide.rst @@ -133,12 +133,12 @@ itself, or a path to a file containing the data. The first returns the latest version number of the data -- i.e., the version of the data that the second function would return if executed. -Consfigurator will call the first function to find out if it needs to call -the first rather than just using its cache. The first function should return -nil if it can't obtain the prerequisite data on this host, perhaps because it -can't decrypt the store. A return value of t represents a request to -Consfigurator to call the second function rather than relying on any cached -values, bypassing the versioning system. +Consfigurator will call the first function to find out if it needs to call the +first rather than just using its caches. The first function should return nil +if it can't obtain the prerequisite data on this host, perhaps because it +can't decrypt the store. If a prerequisite data source wants to effectively +bypass caching and provide fresh data every time Consfigurator deploys the +host, it can use ``GET-UNIVERSAL-TIME`` as its first function. Versions are compared using ``dpkg --compare-versions``. |