Commit eff3de0e authored by David Heuschmann's avatar David Heuschmann Committed by Ian Lance Taylor

os/user: note in doc that user.Current is being cached

user.Current caches the current user after its first call, so changes to
the uid after the first call will not affect its result. As this might
be unexpected, it should be mentioned in the docs.

Fixes #27659

Change-Id: I8b3323d55441d9a79bc9534c6490884d8561889b
Reviewed-on: https://go-review.googlesource.com/136315Reviewed-by: 's avatarIan Lance Taylor <iant@golang.org>
parent 36a3d4f3
......@@ -7,6 +7,10 @@ package user
import "sync"
// Current returns the current user.
//
// The first call will cache the current user information.
// Subsequent calls will return the cached value and will not reflect
// changes to the current user.
func Current() (*User, error) {
cache.Do(func() { cache.u, cache.err = current() })
if cache.err != nil {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment