Skip to content

docs: update license documentation #8465

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

Merged
merged 1 commit into from
Aug 26, 2020
Merged

docs: update license documentation #8465

merged 1 commit into from
Aug 26, 2020

Conversation

Rylan12
Copy link
Member

@Rylan12 Rylan12 commented Aug 24, 2020

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew tests with your changes locally?

Update documentation for the new license syntax.

Changes

  • Add docs/License-Guidelines.md to describe the new syntax
  • Add License Guidelines page to docs/README.md
  • Update docs/Formula-Cookbook.md to describe the new syntax and link to the license guidelines page
  • Update license documentation in formula.rb to be reflected here
    • Change :all to :all_of and :any to :any_of (I must have missed a few last time)
    • Add a link to the License Guidelines page
    • Add a nested example to align with the License Guidelines

Sorry, something went wrong.

@jonchang
Copy link
Contributor

Looks good! Does it make sense to mention HOMEBREW_FORBIDDEN_LICENSES somewhere in these docs?

@Rylan12
Copy link
Member Author

Rylan12 commented Aug 24, 2020

Looks good! Does it make sense to mention HOMEBREW_FORBIDDEN_LICENSES somewhere in these docs?

Probably. Does it make sense to add this to the License Guidelines page? This might fit better in the "Users" section rather than the "Contributors" section of the docs.

@MikeMcQuaid
Copy link
Member

Does it make sense to add this to the License Guidelines page?

I think so! It's already documented for users in the manpage.

@Rylan12
Copy link
Member Author

Rylan12 commented Aug 24, 2020

I added a section to the License Guidelines page with some more information about HOMEBREW_FORBIDDEN_LICENSES

@Rylan12
Copy link
Member Author

Rylan12 commented Aug 25, 2020

I took a second pass through what I wrote and clarified some wording (and fixed some typos). Assuming no one else has any comments, I'll go ahead and merge this tomorrow morning.

Copy link
Contributor

@maxim-belkin maxim-belkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Only one comment but, otherwise, LGTM!

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@Rylan12 Rylan12 merged commit c0c6b07 into Homebrew:master Aug 26, 2020
@Rylan12 Rylan12 deleted the license-docs branch August 26, 2020 14:11
@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Dec 15, 2020
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Dec 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants