From: John Wolfe <jwolfe@vmware.com>
Date: Tue, 21 Jul 2020 18:53:01 +0000 (-0700)
Subject: Improve the LSB distro identification table documentation
X-Git-Tag: stable-11.2.0~118
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0265c8e2a43d45bfcbf9276168c55aa5fa69265e;p=thirdparty%2Fopen-vm-tools.git

Improve the LSB distro identification table documentation

Explain the LSB distro identification table and provide directions
about when to use it.
---

diff --git a/open-vm-tools/lib/misc/hostinfoPosix.c b/open-vm-tools/lib/misc/hostinfoPosix.c
index 8bd86be44..0a57ce085 100644
--- a/open-vm-tools/lib/misc/hostinfoPosix.c
+++ b/open-vm-tools/lib/misc/hostinfoPosix.c
@@ -182,7 +182,19 @@ typedef struct {
    char *filename;
 } DistroInfo;
 
-/* KEEP SORTED! (sort -d) */
+/*
+ * This the list of the locations of the distro identifying file used for
+ * the LSB standard. The LSB standard is an old standard, largely replaced
+ * by the superior os-release standard.
+ *
+ * If a distro *ALWAYS* supports the os-release standard (with or without an
+ * LSB identifying file), there is no need to add anything to this list. For
+ * distros that only support the LSB standard, feel free to add an entry to
+ * this table.
+ *
+ * KEEP SORTED! (sort -d)
+ */
+
 static const DistroInfo distroArray[] = {
    { "ALT",                "/etc/altlinux-release"      },
    { "Annvix",             "/etc/annvix-release"        },