summaryrefslogtreecommitdiff
path: root/lib/ohai/hints.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-09-23 13:46:02 -0700
committerTim Smith <tsmith@chef.io>2018-09-23 20:57:03 -0700
commitf8a8aed228561fd3b746e9973c04fbe1c6671bd8 (patch)
treefec3fc0eecff67716e6578f478f5aab7f8a99caf /lib/ohai/hints.rb
parent13d35c039deada4f523b28c75630831ab3137dd2 (diff)
downloadohai-f8a8aed228561fd3b746e9973c04fbe1c6671bd8.tar.gz
Add more yard commentsyard++
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/ohai/hints.rb')
-rw-r--r--lib/ohai/hints.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/ohai/hints.rb b/lib/ohai/hints.rb
index fd568aa6..ffa02a43 100644
--- a/lib/ohai/hints.rb
+++ b/lib/ohai/hints.rb
@@ -20,6 +20,11 @@
require "ffi_yajl"
module Ohai
+ # Ohai hints are json files on disk that give ohai a hint to things that are often
+ # difficult to discover like certain clouds. Previously they were used for just about
+ # every cloud, but we've since discoverd better ways to auto-detect these clouds.
+ # They are generally dropped off by the knife plugins for those clouds during bootstrap,
+ # but may also be manually dropped off and consumed by 3rd party plugins.
module Hints
# clear out any known hints in the @hints variable
def self.refresh_hints