search

winfsp / cgofuse

Cross-platform FUSE library for Go - Works on Windows, macOS, Linux, FreeBSD, NetBSD, OpenBSD
https://winfsp.dev
MIT License
527 stars 84 forks source link

Rename License.txt to LICENSE.txt #60

Closed sometimesfood closed 3 years ago

sometimesfood commented 3 years ago

This pull request renames License.txt to LICENSE.txt so the license is included in the module zip file.

Apparently, the golang team does not intend to change what files are included in the zip file: https://github.com/golang/go/issues/43817#issuecomment-764854847

billziss-gh commented 3 years ago

@sometimesfood I am unclear on the reasons for renaming the license. Can you please explain the rationale?

sometimesfood commented 3 years ago

Sorry for the confusion, I should have done so earlier.

When importing cgofuse and using go mod vendor, the license file is not distributed with the code because it is not included in the module zip file. This seems to be due to the file name of the license file.

If I import the package github.com/billziss-gh/cgofuse/fuse and use go mod vendor to download a copy of the sources to my vendor directory, the directory vendor/github.com/billziss-gh/cgofuse/ does not contain a copy of the license file.

For comparison: If I import github.com/hashicorp/golang-lru/simplelru, the directory vendor/github.com/hashicorp/golang-lru/ contains a copy of the LICENSE file.

I am not sure why that is, but the golang repo comment linked above indicates it might be due to the file name of the license file in your repo.

sometimesfood commented 3 years ago

Btw, just to be clear: Renaming the license file, adding a new version tag and importing the resulting version from a private repo works just as expected and the license file is included correctly in the module zip file and the vendor directory.

billziss-gh commented 3 years ago

Thank you for the explanation. I will merge this in.

sometimesfood commented 3 years ago

Great, thanks!