TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2024-11-29 04:55:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

util/syspolicy: clean up doc grammar and consistency

Browse Source 
Updates #cleanup

Change-Id: I912574cbd5ef4d8b7417b8b2a9b9a2ccfef88840
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
This commit is contained in:
Brad Fitzpatrick 2024-04-13 17:38:55 -07:00 committed by Brad Fitzpatrick
parent bad3159b62
commit 271cfdb3d3
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
util/syspolicy/handler.go
View File

@ -16,15 +16,19 @@
// Handler reads system policies from OS-specific storage. // Handler reads system policies from OS-specific storage.
type Handler interface { type Handler interface {
// ReadString reads the policy settings value string given the key. // ReadString reads the policy setting's string value for the given key.
// It should return ErrNoSuchKey if the key does not have a value set.
ReadString(key string) (string, error) ReadString(key string) (string, error)
// ReadUInt64 reads the policy settings uint64 value given the key. // ReadUInt64 reads the policy setting's uint64 value for the given key.
// It should return ErrNoSuchKey if the key does not have a value set.
ReadUInt64(key string) (uint64, error) ReadUInt64(key string) (uint64, error)
// ReadBool reads the policy setting's boolean value, given the key. // ReadBool reads the policy setting's boolean value for the given key.
// It should return ErrNoSuchKey if the key does not have a value set.
ReadBoolean(key string) (bool, error) ReadBoolean(key string) (bool, error)
} }
// ErrNoSuchKey is returned when the specified key does not have a value set. // ErrNoSuchKey is returned by a Handler when the specified key does not have a
// value set.
var ErrNoSuchKey = errors.New("no such key") var ErrNoSuchKey = errors.New("no such key")
// defaultHandler is the catch all syspolicy type for anything that isn't windows or apple. // defaultHandler is the catch all syspolicy type for anything that isn't windows or apple.