Document ConnectTCP

landlock-lsm · Jan 15, 2024 · e337b01 · e337b01
1 parent a0b5981
commit e337b01
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/landlock/net_opt.go b/landlock/net_opt.go
@@ -11,6 +11,11 @@ type NetRule struct {
 	port   uint16
 }
 
+// ConnectTCP is a [Rule] which grants the right to connect a socket
+// to a given TCP port.
+//
+// In Go, the connect(2) operation is usually run as part of
+// net.Dial().
 func ConnectTCP(port uint16) NetRule {
 	return NetRule{
 		access: ll.AccessNetConnectTCP,