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/fsquota/fsxattrs/fsxattrs.go b/metropolis/pkg/fsquota/fsxattrs/fsxattrs.go
index 1d455eb..135b886 100644
--- a/metropolis/pkg/fsquota/fsxattrs/fsxattrs.go
+++ b/metropolis/pkg/fsquota/fsxattrs/fsxattrs.go
@@ -46,9 +46,13 @@
FlagHasAttribute FSXAttrFlag = 0x80000000
)
-// FS_IOC_FSGETXATTR/FS_IOC_FSSETXATTR are defined in uapi/linux/fs.h
-const FS_IOC_FSGETXATTR = 0x801c581f
-const FS_IOC_FSSETXATTR = 0x401c5820
+// FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR are defined in uapi/linux/fs.h
+// and normally would be imported from x/sys/unix. Since they don't exist
+// there define them here for now.
+const (
+ FS_IOC_FSGETXATTR = 0x801c581f
+ FS_IOC_FSSETXATTR = 0x401c5820
+)
type FSXAttrs struct {
Flags FSXAttrFlag
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
diff --git a/metropolis/test/nanoswitch/socks.go b/metropolis/test/nanoswitch/socks.go
index 3ca8e34..a85e9a3 100644
--- a/metropolis/test/nanoswitch/socks.go
+++ b/metropolis/test/nanoswitch/socks.go
@@ -9,6 +9,8 @@
"source.monogon.dev/metropolis/pkg/supervisor"
)
+// SOCKSPort is the port at which nanoswitch listens for SOCKS conenctions.
+//
// ONCHANGE(//metropolis/test/launch/cluster:cluster.go): port must be kept in sync
const SOCKSPort uint16 = 1080