open-nomad/vendor/github.com/mitchellh/go-homedir
Seth Hoenig 435c0d9fc8 deps: Switch to Go modules for dependency management
This PR switches the Nomad repository from using govendor to Go modules
for managing dependencies. Aspects of the Nomad workflow remain pretty
much the same. The usual Makefile targets should continue to work as
they always did. The API submodule simply defers to the parent Nomad
version on the repository, keeping the semantics of API versioning that
currently exists.
2020-06-02 14:30:36 -05:00
..
LICENSE vendor github.com/mitchellh/go-homedir for osx 2016-08-18 21:27:27 -05:00
README.md vendor github.com/mitchellh/go-homedir for osx 2016-08-18 21:27:27 -05:00
go.mod deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
homedir.go deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00

README.md

go-homedir

This is a Go library for detecting the user's home directory without the use of cgo, so the library can be used in cross-compilation environments.

Usage is incredibly simple, just call homedir.Dir() to get the home directory for a user, and homedir.Expand() to expand the ~ in a path to the home directory.

Why not just use os/user? The built-in os/user package requires cgo on Darwin systems. This means that any Go code that uses that package cannot cross compile. But 99% of the time the use for os/user is just to retrieve the home directory, which we can do for the current user without cgo. This library does that, enabling cross-compilation.