Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/pkgsite: documentation not displayed for HPND-sell-variant license #49504

Open
xyproto opened this issue Nov 10, 2021 · 8 comments
Open

x/pkgsite: documentation not displayed for HPND-sell-variant license #49504

xyproto opened this issue Nov 10, 2021 · 8 comments

Comments

@xyproto
Copy link
Contributor

@xyproto xyproto commented Nov 10, 2021

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/xyproto/wallutils?utm_source=godoc

What is your user agent?

Mozilla/5.0 (X11; Linux x86_64; rv:95.0) Gecko/20100101 Firefox/95.0

Screenshot

image

What did you do?

Tried to visit and browse the documentation:

http://godoc.org/github.com/xyproto/wallutils

What did you expect to see?

The package documentation.

What did you see instead?

Documentation not displayed due to license restrictions.
See our license policy.

Wallutils is licensed under the MIT license, but the license file contains two of them, separated by --, because the original MIT license has slightly different wording.

@gopherbot gopherbot added this to the pkgsite/license milestone Nov 10, 2021
@D1CED
Copy link

@D1CED D1CED commented Nov 10, 2021

The license demands that

[...] both that copyright notice and this permission notice appear in supporting documentation [...]

which pkg.go.dev clearly does not do. So the choice of not displaying the documentation is justified.

Edit: And your title is incorrect as you can clearly see from the screenshot that an MIT license variant was detected.

Loading

@xyproto
Copy link
Contributor Author

@xyproto xyproto commented Nov 11, 2021

I see. Thanks for the clarification!

Loading

@xyproto xyproto closed this Nov 11, 2021
@xyproto
Copy link
Contributor Author

@xyproto xyproto commented Nov 11, 2021

After moving the license for wayinfo.h from the LICENSE file into the source file at include/wayinfo.h, thus having just one license in the LICENSE file, the documentation for the package is generated and displayed correctly at pkg.go.dev.

I also changed the license from MIT to BSD-3 for the files that are not in include/wayinfo.h.

Moving license text around in the project made pkg.go.dev generate the API documentation. Is this is expected behavior, or an issue with the documentation generator?

Loading

@D1CED
Copy link

@D1CED D1CED commented Nov 11, 2021

Currently go.dev uses github.com/google/licensecheck to detect a projects license which just has a list of files it goes over. It is a simple tool that does not traverse all files and neither does it look for source code comments that may be a license texts.

Here is the current official policy of go.dev along with a list of all the files that are consulted: https://pkg.go.dev/license-policy

Loading

@xyproto
Copy link
Contributor Author

@xyproto xyproto commented Nov 11, 2021

Using a simple license checker tool instead of a more advanced one is a bug in the pkg.go.dev website, then.

Loading

@xyproto xyproto reopened this Nov 11, 2021
@xyproto
Copy link
Contributor Author

@xyproto xyproto commented Nov 11, 2021

Here is the wallutils commit that was the latest commit on main when this issue was first created: be7e0a39ddba14d7f04f2bf2ef22e739a41f54ab

Loading

@seankhliao seankhliao changed the title x/pkgsite: MIT license not detected x/pkgsite: documentation not displayed for HPND-sell-variant license Nov 11, 2021
@seankhliao
Copy link
Contributor

@seankhliao seankhliao commented Nov 11, 2021

the license checker correctly identified it as both HPND-sell-variant and MIT
the issue should be that HPND-sell-variant hasn't been approved

Loading

@xyproto
Copy link
Contributor Author

@xyproto xyproto commented Nov 11, 2021

Also, the HPND-sell-variant license only applies to the C header file wayinfo.h, that is not used when generating the documentation.

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants