aboutsummaryrefslogtreecommitdiff
path: root/src/lib/osinfo/lib_osinfo.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/osinfo/lib_osinfo.md')
-rw-r--r--src/lib/osinfo/lib_osinfo.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/lib/osinfo/lib_osinfo.md b/src/lib/osinfo/lib_osinfo.md
new file mode 100644
index 0000000000..0678ecc21e
--- /dev/null
+++ b/src/lib/osinfo/lib_osinfo.md
@@ -0,0 +1,8 @@
+@dir /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.
+