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 8bd86be44d172ea1c10f5b453b3184449d8bdeda..0a57ce08577720ad4c2b5d5ea103ac4717e43491 100644 (file)
--- 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"        },