1
0
mirror of https://github.com/golang/go synced 2024-11-06 11:36:16 -07:00
go/src
Damien Neil aedf298daf io/fs: document requirement that ReadDir return an unwrapped io.EOF
This requirement ensures that ReadDir implementations are as compatible
as possible with "*os.File".ReadDir.

The testing/fstest package already tests for equality to io.EOF.

Updates #47062.
Fixes #47086.

Change-Id: I54f911a34e507a3db0abc4da55a19b7a50b35041
Reviewed-on: https://go-review.googlesource.com/c/go/+/333149
Reviewed-by: Michael Knyszek <mknyszek@google.com>
2022-05-17 01:50:34 +00:00
..
archive
bufio
builtin
bytes
cmd cmd/compile: tighten the condition for inlining shape/non-shape function 2022-05-17 00:58:22 +00:00
compress compress/flate: remove compressor.hash field 2022-05-11 13:57:00 +00:00
container
context
crypto crypto/aes: simplify key load+store on PPC64 2022-05-13 14:14:49 +00:00
database/sql database/sql: follow convention for field naming 2022-05-14 00:17:10 +00:00
debug
embed
encoding encoding/csv: add Reader.InputOffset method 2022-05-14 04:25:13 +00:00
errors
expvar
flag
fmt
go cmd/compile: set LocalPkg.Path to -p flag 2022-05-16 18:19:47 +00:00
hash
html
image
index/suffixarray
internal cmd/compile: set LocalPkg.Path to -p flag 2022-05-16 18:19:47 +00:00
io io/fs: document requirement that ReadDir return an unwrapped io.EOF 2022-05-17 01:50:34 +00:00
log
math
mime mime: skip globs2 entries that are not simple file extensions 2022-05-13 21:01:01 +00:00
net all: update vendored golang.org/x dependencies for Go 1.19 release 2022-05-16 22:26:23 +00:00
os
path
plugin
reflect
regexp
runtime runtime/pprof: slow new goroutine launches in test 2022-05-16 18:30:07 +00:00
sort
strconv
strings
sync
syscall
testdata
testing Revert "testing: document -race goroutine limits" 2022-05-11 13:55:35 +00:00
text text/template/parse: make atTerminator more efficient 2022-05-16 21:02:09 +00:00
time time: clarify that monotonic clock is not returned by t.Unix 2022-05-13 21:01:13 +00:00
unicode
unsafe
vendor all: update vendored golang.org/x dependencies for Go 1.19 release 2022-05-16 22:26:23 +00:00
all.bash
all.bat all.bat,clean.bat,race.bat,run.bat: call some.bat with .\some.bat 2022-05-12 16:59:17 +00:00
all.rc
bootstrap.bash
buildall.bash
clean.bash
clean.bat all.bat,clean.bat,race.bat,run.bat: call some.bat with .\some.bat 2022-05-12 16:59:17 +00:00
clean.rc
cmp.bash
go.mod all: update vendored golang.org/x dependencies for Go 1.19 release 2022-05-16 22:26:23 +00:00
go.sum all: update vendored golang.org/x dependencies for Go 1.19 release 2022-05-16 22:26:23 +00:00
make.bash
make.bat make.bat: call env.bat with .\env.bat 2022-05-12 13:50:51 +00:00
Make.dist
make.rc
race.bash
race.bat all.bat,clean.bat,race.bat,run.bat: call some.bat with .\some.bat 2022-05-12 16:59:17 +00:00
README.vendor
run.bash
run.bat all.bat,clean.bat,race.bat,run.bat: call some.bat with .\some.bat 2022-05-12 16:59:17 +00:00
run.rc

Vendoring in std and cmd
========================

The Go command maintains copies of external packages needed by the
standard library in the src/vendor and src/cmd/vendor directories.

In GOPATH mode, imports of vendored packages are resolved to these
directories following normal vendor directory logic
(see golang.org/s/go15vendor).

In module mode, std and cmd are modules (defined in src/go.mod and
src/cmd/go.mod). When a package outside std or cmd is imported
by a package inside std or cmd, the import path is interpreted
as if it had a "vendor/" prefix. For example, within "crypto/tls",
an import of "golang.org/x/crypto/cryptobyte" resolves to
"vendor/golang.org/x/crypto/cryptobyte". When a package with the
same path is imported from a package outside std or cmd, it will
be resolved normally. Consequently, a binary may be built with two
copies of a package at different versions if the package is
imported normally and vendored by the standard library.

Vendored packages are internally renamed with a "vendor/" prefix
to preserve the invariant that all packages have distinct paths.
This is necessary to avoid compiler and linker conflicts. Adding
a "vendor/" prefix also maintains the invariant that standard
library packages begin with a dotless path element.

The module requirements of std and cmd do not influence version
selection in other modules. They are only considered when running
module commands like 'go get' and 'go mod vendor' from a directory
in GOROOT/src.

Maintaining vendor directories
==============================

Before updating vendor directories, ensure that module mode is enabled.
Make sure GO111MODULE=off is not set ('on' or 'auto' should work).

Requirements may be added, updated, and removed with 'go get'.
The vendor directory may be updated with 'go mod vendor'.
A typical sequence might be:

    cd src
    go get -d golang.org/x/net@latest
    go mod tidy
    go mod vendor

Use caution when passing '-u' to 'go get'. The '-u' flag updates
modules providing all transitively imported packages, not only
the module providing the target package.

Note that 'go mod vendor' only copies packages that are transitively
imported by packages in the current module. If a new package is needed,
it should be imported before running 'go mod vendor'.