treewide: documentation on exported values should start with their name
Change-Id: I1bd89db3d9be101a682d8c18ebeb18f19fb189f4
Reviewed-on: https://review.monogon.dev/c/monogon/+/3029
Tested-by: Jenkins CI
Vouch-Run-CI: Tim Windelschmidt <tim@monogon.tech>
Reviewed-by: Serge Bazanski <serge@monogon.tech>
diff --git a/metropolis/pkg/smbios/structures.go b/metropolis/pkg/smbios/structures.go
index a6bdb86..4c75709 100644
--- a/metropolis/pkg/smbios/structures.go
+++ b/metropolis/pkg/smbios/structures.go
@@ -12,7 +12,9 @@
structTypeMemoryDevice = 17
)
-// Table 7.1.2.2 Bit 3
+// UEFISpecificationSupported is a bitmask for accessing the third bit,
+// which displays the support of UEFI in the smbios structure. For more
+// information check the SMBIOS documentation at Table 7.1.2.2 Bit 3.
const UEFISpecificationSupported = 1 << 3
// BIOSInformationRaw contains decoded data from the BIOS Information structure