diff options
Diffstat (limited to 'src/lib/osinfo')
-rw-r--r-- | src/lib/osinfo/lib_osinfo.dox | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/lib/osinfo/lib_osinfo.dox b/src/lib/osinfo/lib_osinfo.dox index 7733755f20..c78615937b 100644 --- a/src/lib/osinfo/lib_osinfo.dox +++ b/src/lib/osinfo/lib_osinfo.dox @@ -1,4 +1,10 @@ /** @dir lib/osinfo -@brief lib/osinfo +@brief lib/osinfo: For inspecting the OS version and capabilities. + +In general, we use this module when we're telling the user what operating +system they are running. We shouldn't make decisions based on the output of +these checks: instead, we should have more specific checks, either at compile +time or run time, based on the observed system behavior. + **/ |