Skip to content

Commit bc37ffe

Browse files
committed
README: mention {vfs,doc}.go license
Signed-off-by: Aleksa Sarai <[email protected]>
1 parent 6fcfed1 commit bc37ffe

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ func SecureJoin(root, unsafePath string) (string, error) {
6767
[libpathrs]: https://github.com/openSUSE/libpathrs
6868
[go#20126]: https://github.com/golang/go/issues/20126
6969

70-
### New API ###
70+
### <a name="new-api" /> New API ###
71+
[#new-api]: #new-api
7172

7273
While we recommend users switch to [libpathrs][libpathrs] as soon as it has a
7374
stable release, some methods implemented by libpathrs have been ported to this
@@ -169,14 +170,20 @@ Some of the code in this project is derived from Go, and is licensed under a
169170
BSD 3-clause license (available in `LICENSE.BSD`). At time of writing, these
170171
are:
171172

172-
* `gocompat_*.go` (backports to provide compatibility with older Go versions)
173+
* `doc.go` (module documentation).
174+
* `gocompat_*.go` (backports to provide compatibility with older Go versions).
173175
* `join*.go` (port of Docker's symlink expansion, originally based on the
174-
stdlib `filepath.EvalSymlinks`)
176+
stdlib `filepath.EvalSymlinks`).
177+
* `vfs.go` (minimal filesystem interfaces which was added in order to facility
178+
complete rootless support for [umoci][umoci]).
175179

176180
The rest of the files (many of which are derived from [libpathrs][libpathrs])
177181
are licensed under the Mozilla Public License version 2.0 (available in
178-
`LICENSE.MPL-2.0`).
182+
`LICENSE.MPL-2.0`). If you are using the "New API" [described above][#new-api],
183+
you are probably using code from files released under this license.
179184

180185
Every source file in this project has a copyright header describing its
181186
license. Please check the license headers of each file to see what license
182187
applies to it.
188+
189+
[umoci]: https://github.com/opencontainers/umoci

0 commit comments

Comments
 (0)