diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 02d5a3293a56e..13da58ca34192 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,30 +8,4 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c * read [the Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting) * open an issue on the formula's repository -### Submit a `1.2.3` version upgrade for the `foo` formula - -* check if the same upgrade has been already submitted by [searching the open pull requests for `foo`](https://github.com/Homebrew/homebrew/pulls?utf8=✓&q=is%3Apr+is%3Aopen+foo). -* `brew edit foo` -* edit [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) and [`sha256`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#sha256%3D-class_method)/[`tag`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method), leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is -* `brew install foo` -* run `brew audit foo` and fix any issues -* `git commit` with commit subject `foo 1.2.3` -* [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests - -### Add a new formula for `foo` version `2.3.4` from `$URL` - -* read [the Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook) or: `brew create $URL` and make edits -* `brew install foo` -* `brew audit --online --strict foo` -* `git commit` with message formatted `foo 2.3.4 (new formula)` -* [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests - -### Contribute a fix to the `foo` formula - -* `brew edit foo` and make edits -* leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is -* `brew install foo`, `brew test foo`, and `brew audit foo` -* `git commit` with message formatted `foo: fix ` -* [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests - Thanks! diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 6cc5bc00d72f0..43740ba5ee867 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -8,13 +8,10 @@ _You can erase any parts of this template not applicable to your Issue._ ### Bug reports: -Please replace this line with a brief summary of your issue **AND** if reporting a build issue include the link from: +Please replace this line with a brief summary of your issue. -`brew gist-logs ` -(where `` is the name of the formula that failed to build). +### Feature Requests: -### Feature/Formula Requests: - -**Please note by far the quickest way to get a new feature or formula into Homebrew is to file a [Pull Request](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md).** +**Please note by far the quickest way to get a new feature into Homebrew is to file a [Pull Request](https://github.com/Homebrew/brew/blob/master/.github/CONTRIBUTING.md).** We will consider your request but it may be closed if it's something we're not actively planning to work on. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0b9b94b04a5c2..cbf5afb752893 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,5 @@ -### All Submissions: - -- [ ] Have you followed the guidelines in our [Contributing](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md) document? -- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/Homebrew/homebrew/pulls) for the same update/change? - -_You can erase any parts of this template not applicable to your Pull Request._ - -### New Formulae Submissions: - -- [ ] Does your submission pass -`brew audit --strict --online ` (where `` is the name of the formula you're submitting)? -- [ ] Have you built your formula locally prior to submission with `brew install `? - -### Changes to Homebrew's Core: - +- [ ] Have you followed the guidelines in our [Contributing](https://github.com/Homebrew/brew/blob/master/.github/CONTRIBUTING.md) document? +- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/Homebrew/brew/pulls) 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 core changes, as applicable? [Here's an example](https://github.com/Homebrew/homebrew/pull/49031) if you'd like one. +- [ ] Have you written new tests for your changes? [Here's an example](https://github.com/Homebrew/homebrew/pull/49031). - [ ] Have you successfully ran `brew tests` with your changes locally? diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md index 6b0b72244c7f8..ccf0a02d79f33 100644 --- a/Library/Homebrew/README.md +++ b/Library/Homebrew/README.md @@ -3,6 +3,6 @@ This is the (partially) documented public API for Homebrew. The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private. -You may also find the [Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae. +You may also find the [Formula Cookbook](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae. Good luck! diff --git a/Library/Homebrew/cmd/create.rb b/Library/Homebrew/cmd/create.rb index 2bdcd19b8cb74..a468189c411dc 100644 --- a/Library/Homebrew/cmd/create.rb +++ b/Library/Homebrew/cmd/create.rb @@ -129,8 +129,8 @@ def generate! end def template; <<-EOS.undent - # Documentation: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md - # http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula + # Documentation: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md + # http://www.rubydoc.info/github/Homebrew/brew/master/Formula # PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST! class #{Formulary.class_s(name)} < Formula diff --git a/Library/Homebrew/cmd/help.rb b/Library/Homebrew/cmd/help.rb index 6e1f3f07aa240..f729c0e8c2e25 100644 --- a/Library/Homebrew/cmd/help.rb +++ b/Library/Homebrew/cmd/help.rb @@ -17,7 +17,7 @@ Brewing: brew create [URL [--no-fetch]] brew edit [FORMULA...] - https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md + https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md Further help: man brew diff --git a/Library/Homebrew/cmd/tap-readme.rb b/Library/Homebrew/cmd/tap-readme.rb index 2845cc85bc53d..032ec2b79e033 100644 --- a/Library/Homebrew/cmd/tap-readme.rb +++ b/Library/Homebrew/cmd/tap-readme.rb @@ -21,7 +21,7 @@ def tap_readme ``` ## Documentation - `brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme). + `brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme). EOS puts template if ARGV.verbose? diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index d9c648c9c9aed..9047f69d02a34 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -1697,7 +1697,7 @@ def mirror(val) # and you haven't passed or previously used any options on this formula. # # If you maintain your own repository, you can add your own bottle links. - # https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Bottles.md + # https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Bottles.md # You can ignore this block entirely if submitting to Homebrew/Homebrew, It'll be # handled for you by the Brew Test Bot. # diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md index 276449a84afba..4863bcd5db4bc 100644 --- a/Library/Homebrew/manpages/brew.1.md +++ b/Library/Homebrew/manpages/brew.1.md @@ -88,7 +88,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note and version, but if it fails, you'll have to make your own template. The `wget` formula serves as a simple example. For the complete API have a look at - + If `--autotools` is passed, create a basic template for an Autotools-style build. If `--cmake` is passed, create a basic template for a CMake-style build. @@ -194,7 +194,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note information on all installed formulae. See the docs for examples of using the JSON: - + * `install` [`--debug`] [`--env=`|] [`--ignore-dependencies`] [`--only-dependencies`] [`--cc=`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] : Install . @@ -415,7 +415,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Pass `--installed` to get information on installed taps. See the docs for examples of using the JSON: - + * `tap-pin` : Pin , prioritizing its formulae over core when formula names are supplied @@ -543,7 +543,7 @@ scripts that reside somewhere in the `PATH`, named `brew-` or to create your own commands without modifying Homebrew's internals. Instructions for creating your own commands can be found in the docs: - + ## SPECIFYING FORMULAE @@ -714,7 +714,7 @@ If your proxy requires authentication: ## SEE ALSO -Homebrew Documentation: +Homebrew Documentation: `git`(1), `git-log`(1) @@ -728,6 +728,6 @@ Former maintainers with significant contributions include Jack Nagel, Adam Vande See our issues on GitHub: - * Homebrew + * Homebrew/brew * Homebrew/homebrew-core diff --git a/Library/Homebrew/os/mac/xcode.rb b/Library/Homebrew/os/mac/xcode.rb index d0eb50da01df7..dc7360c1de553 100644 --- a/Library/Homebrew/os/mac/xcode.rb +++ b/Library/Homebrew/os/mac/xcode.rb @@ -105,7 +105,7 @@ def uncached_version when 2327..2333 then "3.2.5" when 2335 # this build number applies to 3.2.6, 4.0 and 4.1 - # https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Xcode.md + # https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Xcode.md "4.0" else case (MacOS.clang_version.to_f * 10).to_i diff --git a/Library/Homebrew/test/test_cmd_info.rb b/Library/Homebrew/test/test_cmd_info.rb index c9f66c4d8d2f4..ddc06ee01c335 100644 --- a/Library/Homebrew/test/test_cmd_info.rb +++ b/Library/Homebrew/test/test_cmd_info.rb @@ -4,10 +4,10 @@ class InfoCommandTests < Homebrew::TestCase def test_github_remote_path - remote = "https://github.com/Homebrew/homebrew" - assert_equal "https://github.com/Homebrew/homebrew/blob/master/Formula/git.rb", + remote = "https://github.com/Homebrew/homebrew-core" + assert_equal "https://github.com/Homebrew/homebrew-core/blob/master/Formula/git.rb", Homebrew.github_remote_path(remote, "Formula/git.rb") - assert_equal "https://github.com/Homebrew/homebrew/blob/master/Formula/git.rb", + assert_equal "https://github.com/Homebrew/homebrew-core/blob/master/Formula/git.rb", Homebrew.github_remote_path("#{remote}.git", "Formula/git.rb") assert_equal "https://github.com/user/repo/blob/master/foo.rb", diff --git a/README.md b/README.md index 81eeae8ff63d0..c4d41d5d7d064 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Features, usage and installation instructions are [summarised on the homepage](h 3. Or use `brew search --desc` to browse packages from the command line. ## More Documentation -`brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme). +`brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme). ## Troubleshooting First, please run `brew update` and `brew doctor`. -Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting). +Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting). **If you don't read these it will take us far longer to help you with your problem.** @@ -30,7 +30,7 @@ Homebrew's current maintainers are [Misty De Meo](https://github.com/mistydemeo) Former maintainers with significant contributions include [Jack Nagel](https://github.com/jacknagel), [Adam Vandenberg](https://github.com/adamv) and Homebrew's creator: [Max Howell](https://github.com/mxcl). ## License -Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/Homebrew/homebrew/tree/master/LICENSE.txt). +Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/Homebrew/brew/tree/master/LICENSE.txt). Documentation is under the [Creative Commons Attribution license](https://creativecommons.org/licenses/by/4.0/). ## Donations @@ -41,14 +41,14 @@ Homebrew is a member of the [Software Freedom Conservancy](http://sfconservancy. - [Donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V6ZE57MJRYC8L) - Donate by USA $ check from a USA bank: - Make check payable to "Software Freedom Conservancy, Inc." and place "Directed donation: Homebrew" in the memo field. Checks should then be mailed to: - - Software Freedom Conservancy, Inc. - 137 Montague ST STE 380 - BROOKLYN, NY 11201 USA + - Software Freedom Conservancy, Inc. + 137 Montague ST STE 380 + BROOKLYN, NY 11201 USA - Donate by wire transfer: contact accounting@sfconservancy.org for wire transfer details. - Donate with Flattr or PayPal Giving Fund: coming soon. ## Sponsors -Our CI infrastructure was paid for by [our Kickstarter supporters](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Kickstarter-Supporters.md). +Our CI infrastructure was paid for by [our Kickstarter supporters](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Kickstarter-Supporters.md). Our CI infrastructure is hosted by [The Positive Internet Company](http://www.positive-internet.com). diff --git a/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md b/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md index ad118cc6fdab9..f37e57ab99519 100644 --- a/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md +++ b/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md @@ -7,9 +7,9 @@ There are two types of Jenkins jobs you will interact with: This job automatically builds any pull requests submitted to Homebrew/homebrew-core. On success or failure it updates the pull request status (see more details on the [main Brew Test Bot wiki page](Brew-Test-Bot.md)). On a successful build it automatically uploads bottles. ## [Homebrew Testing](http://bot.brew.sh/job/Homebrew%20Testing/) -This job is manually triggered to run [`brew test-bot`](https://github.com/Homebrew/homebrew/blob/master/Library/Homebrew/cmd/test-bot.rb) with user-specified parameters. On a successful build it automatically uploads bottles. +This job is manually triggered to run [`brew test-bot`](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/cmd/test-bot.rb) with user-specified parameters. On a successful build it automatically uploads bottles. -You can manually start this job with parameters to run [`brew test-bot`](https://github.com/Homebrew/homebrew/blob/master/Library/Homebrew/cmd/test-bot.rb) with the same parameters. It's often useful to pass a pull request URL, a commit URL, a commit SHA-1 and/or formula names to have `brew-test-bot` test them, report the results and produce bottles. +You can manually start this job with parameters to run [`brew test-bot`](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/cmd/test-bot.rb) with the same parameters. It's often useful to pass a pull request URL, a commit URL, a commit SHA-1 and/or formula names to have `brew-test-bot` test them, report the results and produce bottles. ## Bottling To pull and bottle a pull request with `brew pull`: diff --git a/share/doc/homebrew/Brew-Test-Bot.md b/share/doc/homebrew/Brew-Test-Bot.md index 220f82419043b..78823ad8709f3 100644 --- a/share/doc/homebrew/Brew-Test-Bot.md +++ b/share/doc/homebrew/Brew-Test-Bot.md @@ -4,7 +4,7 @@ by [our Kickstarter in 2013](https://www.kickstarter.com/projects/homebrew/brew- It comprises of four Mac Minis running in a data centre in England which host [a Jenkins instance at http://bot.brew.sh](http://bot.brew.sh) and run the -[`brew-test-bot.rb`](https://github.com/Homebrew/homebrew/blob/master/Library/Homebrew/cmd/test-bot.rb) +[`brew-test-bot.rb`](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/cmd/test-bot.rb) Ruby script to perform automated testing of commits to the master branch, pull requests and custom builds requested by maintainers. diff --git a/share/doc/homebrew/Common-Issues.md b/share/doc/homebrew/Common-Issues.md index 7d8c8640c0321..c88f52e154318 100644 --- a/share/doc/homebrew/Common-Issues.md +++ b/share/doc/homebrew/Common-Issues.md @@ -76,7 +76,7 @@ When running `brew upgrade`, you see something like this: $ brew upgrade Error: undefined method `include?' for nil:NilClass Please report this bug: - https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md + https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md /usr/local/Library/Homebrew/formula.rb:393:in `canonical_name' /usr/local/Library/Homebrew/formula.rb:425:in `factory' /usr/local/Library/Contributions/examples/brew-upgrade.rb:7 diff --git a/share/doc/homebrew/External-Commands.md b/share/doc/homebrew/External-Commands.md index 967ee739edc71..08526b4bc59b6 100644 --- a/share/doc/homebrew/External-Commands.md +++ b/share/doc/homebrew/External-Commands.md @@ -95,4 +95,4 @@ These commands have been contributed by Homebrew users but are not included in t > ``` ## SEE ALSO -Homebrew Docs: +Homebrew Docs: diff --git a/share/doc/homebrew/Formula-Cookbook.md b/share/doc/homebrew/Formula-Cookbook.md index ca48e8df6c169..7b07c47180ce2 100644 --- a/share/doc/homebrew/Formula-Cookbook.md +++ b/share/doc/homebrew/Formula-Cookbook.md @@ -1,5 +1,5 @@ # Formula Cookbook -A formula is a package definition written in Ruby. It can be created with `brew create $URL` and installed with `brew install $FORMULA` and debugged with `brew install --debug --verbose $FORMULA`. Formulae use the [Formula API](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula) which provides various Homebrew-specific helpers. +A formula is a package definition written in Ruby. It can be created with `brew create $URL` and installed with `brew install $FORMULA` and debugged with `brew install --debug --verbose $FORMULA`. Formulae use the [Formula API](http://www.rubydoc.info/github/Homebrew/brew/master/Formula) which provides various Homebrew-specific helpers. ## Homebrew Terminology @@ -34,7 +34,7 @@ Before submitting a new formula make sure your package: * has a stable, tagged version (i.e. not just a GitHub repository with no versions). See [Interesting-Taps-&-Branches](Interesting-Taps-&-Branches.md) for where pre-release versions belong. * passes all `brew audit --strict --online $FORMULA` tests. -Before submitting a new formula make sure you read over our [contribution guidelines](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md). +Before submitting a new formula make sure you read over our [contribution guidelines](https://github.com/Homebrew/brew/blob/master/.github/CONTRIBUTING.md). ## Grab the URL @@ -63,18 +63,18 @@ class Foo < Formula end ``` -If `brew` said `Warning: Version cannot be determined from URL` when doing the `create` step, you’ll need to explicitly add the correct [`version`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#version-class_method) to the formula and then save the formula. +If `brew` said `Warning: Version cannot be determined from URL` when doing the `create` step, you’ll need to explicitly add the correct [`version`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#version-class_method) to the formula and then save the formula. Homebrew will try to guess the formula’s name from its URL. If it fails to do so you can override this with `brew create --set-name `. -## Fill in the [`homepage`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#homepage%3D-class_method) +## Fill in the [`homepage`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#homepage%3D-class_method) -**We don’t accept formulae without a [`homepage`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#homepage%3D-class_method)!** +**We don’t accept formulae without a [`homepage`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#homepage%3D-class_method)!** -A SSL/TLS (https) [`homepage`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#homepage%3D-class_method) is preferred, if one is available. +A SSL/TLS (https) [`homepage`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#homepage%3D-class_method) is preferred, if one is available. -Try to summarize from the [`homepage`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#homepage%3D-class_method) what the formula does in the [`desc`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#desc%3D-class_method)ription. Note that the [`desc`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#desc%3D-class_method)ription is automatically prepended with the formula name. +Try to summarize from the [`homepage`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#homepage%3D-class_method) what the formula does in the [`desc`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#desc%3D-class_method)ription. Note that the [`desc`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#desc%3D-class_method)ription is automatically prepended with the formula name. ## Check the build system @@ -105,7 +105,7 @@ We generally try to not duplicate system libraries and complicated tools in core One very special exception is OpenSSL. Anything that uses OpenSSL *should* be built using Homebrew’s shipped OpenSSL and our test bot's post-install `audit` will warn if it detects you haven't done this. Homebrew’s OpenSSL is -[`keg_only`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#keg_only-class_method) +[`keg_only`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#keg_only-class_method) to avoid conflicting with the system so sometimes formulae need to have environment variables set or special configuration flags passed to locate our OpenSSL. You can see this mechanism in the @@ -116,7 +116,7 @@ prefix. Homebrew maintains a special [tap that provides other useful system duplicates](https://github.com/Homebrew/homebrew-dupes). -*Important:* `$(brew --prefix)/bin` is NOT on the `$PATH` during formula installation. If you have dependencies at build time, you must specify them and brew will add them to the `$PATH` or create a [`Requirement`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Requirement). +*Important:* `$(brew --prefix)/bin` is NOT on the `$PATH` during formula installation. If you have dependencies at build time, you must specify them and brew will add them to the `$PATH` or create a [`Requirement`](http://www.rubydoc.info/github/Homebrew/brew/master/Requirement). ## Specifying other formulae as dependencies @@ -132,7 +132,7 @@ end A String (e.g. `"jpeg"`) specifies a formula dependency. -A Symbol (e.g. `:x11`) specifies a [`Requirement`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Requirement) which can be fulfilled by one or more formulae, casks or other system-wide installed software (e.g. X11). +A Symbol (e.g. `:x11`) specifies a [`Requirement`](http://www.rubydoc.info/github/Homebrew/brew/master/Requirement) which can be fulfilled by one or more formulae, casks or other system-wide installed software (e.g. X11). A Hash (e.g. `=>`) specifies a formula dependency with some additional information. Given a single string key, the value can take several forms: @@ -166,16 +166,16 @@ A Hash (e.g. `=>`) specifies a formula dependency with some additional informati ## Specifying conflicts with other formulae -Sometimes there’s hard conflict between formulae, and it can’t be avoided or circumvented with [`keg_only`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#keg_only-class_method). +Sometimes there’s hard conflict between formulae, and it can’t be avoided or circumvented with [`keg_only`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#keg_only-class_method). `mbedtls` is a good [example](https://github.com/Homebrew/homebrew-core/blob/master/Formula/mbedtls.rb) formula for minor conflict. `mbedtls` ships and compiles a "Hello World" executable. This is obviously non-essential to `mbedtls`’s functionality, and conflict with the popular GNU `hello` formula would be overkill, so we just remove it. [pdftohtml](https://github.com/Homebrew/homebrew-core/blob/master/Formula/pdftohtml.rb) provides an example of a serious -conflict, where both formula ship an identically-named binary that is essential to functionality, so a [`conflicts_with`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#conflicts_with-class_method) is preferable. +conflict, where both formula ship an identically-named binary that is essential to functionality, so a [`conflicts_with`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#conflicts_with-class_method) is preferable. -As a general rule, [`conflicts_with`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#conflicts_with-class_method) should be a last-resort option. It’s a fairly blunt instrument. +As a general rule, [`conflicts_with`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#conflicts_with-class_method) should be a last-resort option. It’s a fairly blunt instrument. The syntax for conflict that can’t be worked around is: @@ -187,11 +187,11 @@ conflicts_with "blueduck", :because => "yellowduck also ships a duck binary" In Homebrew we sometimes accept formulae updates that don’t include a version bump. These include resource updates, new patches or fixing a security issue with a formula. -Occasionally, these updates require a forced-recompile of the formula itself or its dependents to either ensure formulae continue to function as expected or to close a security issue. This forced-recompile is known as a [`revision`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#revision%3D-class_method) and inserted underneath the `homepage`/`url`/`sha` block. +Occasionally, these updates require a forced-recompile of the formula itself or its dependents to either ensure formulae continue to function as expected or to close a security issue. This forced-recompile is known as a [`revision`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#revision%3D-class_method) and inserted underneath the `homepage`/`url`/`sha` block. -Where a dependent of a formula fails against a new version of that dependency it must receive a [`revision`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#revision%3D-class_method). An example of such failure can be seen [here](https://github.com/Homebrew/homebrew/issues/31195) and the fix [here](https://github.com/Homebrew/homebrew/pull/31207). +Where a dependent of a formula fails against a new version of that dependency it must receive a [`revision`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#revision%3D-class_method). An example of such failure can be seen [here](https://github.com/Homebrew/homebrew/issues/31195) and the fix [here](https://github.com/Homebrew/homebrew/pull/31207). -[`revision`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#revision%3D-class_method)s are also used for formulae that move from the system OpenSSL to the Homebrew-shipped OpenSSL without any other changes to that formula. This ensures users aren’t left exposed to the potential security issues of the outdated OpenSSL. An example of this can be seen in [this commit](https://github.com/Homebrew/homebrew/commit/6b9d60d474d72b1848304297d91adc6120ea6f96). +[`revision`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#revision%3D-class_method)s are also used for formulae that move from the system OpenSSL to the Homebrew-shipped OpenSSL without any other changes to that formula. This ensures users aren’t left exposed to the potential security issues of the outdated OpenSSL. An example of this can be seen in [this commit](https://github.com/Homebrew/homebrew/commit/6b9d60d474d72b1848304297d91adc6120ea6f96). ## Double-check for dependencies @@ -216,7 +216,7 @@ $ otool -L /usr/local/bin/ldapvi Homebrew doesn’t package already packaged language-specific libraries. These should be installed directly from `gem`/`cpan`/`pip` etc. -If you're installing an application then please use [`resource`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#resource-class_method)s for all the language-specific dependencies: +If you're installing an application then please use [`resource`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#resource-class_method)s for all the language-specific dependencies: ```ruby class Foo < Formula @@ -247,15 +247,15 @@ Check the top of the e.g. `./configure` output. Some configure scripts do not re ## Add a test to the formula -Please add a [`test do`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#test-class_method) block to the formula. This will be run by `brew test foo` and the [Brew Test Bot](Brew-Test-Bot.md). +Please add a [`test do`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#test-class_method) block to the formula. This will be run by `brew test foo` and the [Brew Test Bot](Brew-Test-Bot.md). The -[`test do`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#test-class_method) +[`test do`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#test-class_method) block automatically creates and changes to a temporary directory which is deleted after run. You can access this -[`Pathname`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Pathname) +[`Pathname`](http://www.rubydoc.info/github/Homebrew/brew/master/Pathname) with the -[`testpath`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#testpath-instance_method) +[`testpath`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#testpath-instance_method) function. The environment variable `HOME` is set to `testpath` within the `test do` block. @@ -279,7 +279,7 @@ If you’re not sure about the name check the homepage, and check the Wikipedia Where Homebrew already has a formula called `foo` we typically do not accept requests to replace that formula with something else also named `foo`. This is to avoid both confusing and surprising users’ expectation. -When two formulae share an upstream name, e.g. [`AESCrypt`](https://github.com/Homebrew/homebrew-core/blob/master/Formula/aescrypt.rb) and [`AESCrypt`](https://github.com/Homebrew/homebrew/blob-core/master/Formula/aescrypt-packetizer.rb) the newer formula must typically adapt the name to avoid conflict with the current formula. +When two formulae share an upstream name, e.g. [`AESCrypt`](https://github.com/Homebrew/homebrew-core/blob/master/Formula/aescrypt.rb) and [`AESCrypt`](https://github.com/Homebrew/homebrew-core/blob/master/Formula/aescrypt-packetizer.rb) the newer formula must typically adapt the name to avoid conflict with the current formula. If you’re *still* not sure, just commit. We’ll apply some arbitrary rule and make a decision :wink:. @@ -299,7 +299,7 @@ You can run `brew audit --strict --online` to test formulae for adherence to Hom New formulae being submitted to Homebrew should run `brew audit --strict --online foo`. This command is performed by the Brew Test Bot on new submissions as part of the automated build and test process, and highlights more potential issues than the standard audit. Use `brew info` and check if the version guessed by Homebrew from the URL is -correct. Add an explicit [`version`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#version-class_method) if not. +correct. Add an explicit [`version`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#version-class_method) if not. ## Commit @@ -340,7 +340,7 @@ If you have already forked Homebrew on GitHub, then you can manually push (just git push https://github.com/myname/homebrew/ ``` -Now, please [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) for your changes. +Now, please [open a pull request](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) for your changes. * One formula per commit; one commit per formula * Keep merge commits out of the pull request @@ -367,7 +367,7 @@ system "make", "install" You’ll see stuff like that in other formulae. This moves the file `foo` into the Formula’s `bin` directory (`/usr/local/Cellar/pkg/0.1/bin`) and makes it executable (`chmod 0555 foo`). -## [`inreplace`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Utils/Inreplace) +## [`inreplace`](http://www.rubydoc.info/github/Homebrew/brew/master/Utils/Inreplace) A convenience function that can edit files in-place. For example: @@ -404,13 +404,13 @@ Note that values *can* contain unescaped spaces if you use the multiple-argument ## Patches -While [`patch`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#patch-class_method)es should generally be avoided, sometimes they are necessary. +While [`patch`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#patch-class_method)es should generally be avoided, sometimes they are necessary. -When [`patch`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#patch-class_method)ing (i.e. fixing header file inclusion, fixing compiler warnings, etc.) the first thing to do is check whether or not the upstream project is aware of the issue. If not, file a bug report and/or submit your patch for inclusion. We may sometimes still accept your patch before it was submitted upstream but by getting the ball rolling on fixing the upstream issue you reduce the length of time we have to carry the patch around. +When [`patch`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#patch-class_method)ing (i.e. fixing header file inclusion, fixing compiler warnings, etc.) the first thing to do is check whether or not the upstream project is aware of the issue. If not, file a bug report and/or submit your patch for inclusion. We may sometimes still accept your patch before it was submitted upstream but by getting the ball rolling on fixing the upstream issue you reduce the length of time we have to carry the patch around. -*Always justify a [`patch`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#patch-class_method) with a code comment!* Otherwise, nobody will know when it is safe to remove the patch, or safe to leave it in when updating the formula. The comment should include a link to the relevant upstream issue(s). +*Always justify a [`patch`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#patch-class_method) with a code comment!* Otherwise, nobody will know when it is safe to remove the patch, or safe to leave it in when updating the formula. The comment should include a link to the relevant upstream issue(s). -External [`patch`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#patch-class_method)es can be declared using resource-style blocks: +External [`patch`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#patch-class_method)es can be declared using resource-style blocks: ```ruby patch do @@ -428,7 +428,7 @@ patch :p0 do end ``` -[`patch`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#patch-class_method)es can be declared in [`stable`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#stable-class_method), [`devel`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#devel-class_method), and [`head`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#head-class_method) blocks. NOTE: always use a block instead of a conditional, i.e. `stable do ... end` instead of `if build.stable? then ... end`. +[`patch`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#patch-class_method)es can be declared in [`stable`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#stable-class_method), [`devel`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#devel-class_method), and [`head`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#head-class_method) blocks. NOTE: always use a block instead of a conditional, i.e. `stable do ... end` instead of `if build.stable? then ... end`. ```rb stable do @@ -485,11 +485,11 @@ If anything isn’t clear, you can usually figure it out by `grep`ping the `$(br ## Unstable versions (`devel`, `head`) -Formulae can specify alternate downloads for the upstream project’s [`devel`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#devel-class_method) release (unstable but not `master`/`trunk`) or [`head`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#head-class_method) (`master`/`trunk`). +Formulae can specify alternate downloads for the upstream project’s [`devel`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#devel-class_method) release (unstable but not `master`/`trunk`) or [`head`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#head-class_method) (`master`/`trunk`). ### `devel` -The [`devel`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#devel-class_method) spec (activated by passing `--devel`) is used for a project’s unstable releases. It is specified in a block: +The [`devel`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#devel-class_method) spec (activated by passing `--devel`) is used for a project’s unstable releases. It is specified in a block: ```ruby devel do @@ -502,7 +502,7 @@ You can test if the `devel` spec is in use with `build.devel?`. ### `head` -[`head`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#head-class_method) URLs (activated by passing `--HEAD`) build the development cutting edge. Specifying it is easy: +[`head`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#head-class_method) URLs (activated by passing `--HEAD`) build the development cutting edge. Specifying it is easy: ```ruby class Foo < Formula @@ -510,9 +510,9 @@ class Foo < Formula end ``` -Homebrew understands `git`, `svn`, and `hg` URLs, and has a way to specify `cvs` repositories as a URL as well. You can test whether the [`head`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#head-class_method) is being built with `build.head?`. +Homebrew understands `git`, `svn`, and `hg` URLs, and has a way to specify `cvs` repositories as a URL as well. You can test whether the [`head`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#head-class_method) is being built with `build.head?`. -To use a specific commit, tag, or branch from a repository, specify [`head`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#head-class_method) with the `:tag` and `:revision`, `:revision`, or `:branch` option, like so: +To use a specific commit, tag, or branch from a repository, specify [`head`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#head-class_method) with the `:tag` and `:revision`, `:revision`, or `:branch` option, like so: ```ruby class Foo < Formula @@ -525,7 +525,7 @@ end ## Compiler selection -Sometimes a package fails to build when using a certain compiler. Since recent Xcodes no longer include a GCC compiler we cannot simply force the use of GCC. Instead, the correct way to declare this is the [`fails_with` DSL method](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#fails_with-class_method). A properly constructed [`fails_with`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#fails_with-class_method) block documents the latest compiler build version known to cause compilation to fail, and the cause of the failure. For example: +Sometimes a package fails to build when using a certain compiler. Since recent Xcodes no longer include a GCC compiler we cannot simply force the use of GCC. Instead, the correct way to declare this is the [`fails_with` DSL method](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#fails_with-class_method). A properly constructed [`fails_with`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#fails_with-class_method) block documents the latest compiler build version known to cause compilation to fail, and the cause of the failure. For example: ```ruby fails_with :llvm do @@ -541,7 +541,7 @@ end `build` takes a Fixnum (an integer; you can find this number in your `brew --config` output). `cause` takes a String, and the use of heredocs is encouraged to improve readability and allow for more comprehensive documentation. -[`fails_with`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#fails_with-class_method) declarations can be used with any of `:gcc`, `:llvm`, and `:clang`. Homebrew will use this information to select a working compiler (if one is available). +[`fails_with`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#fails_with-class_method) declarations can be used with any of `:gcc`, `:llvm`, and `:clang`. Homebrew will use this information to select a working compiler (if one is available). ## Specifying the Download Strategy explicitly @@ -568,7 +568,7 @@ Download strategies offered by Homebrew are: | `:post` | `CurlPostDownloadStrategy` | | `:svn` | `SubversionDownloadStrategy` | -If you need more control over the way files are downloaded and staged, you can create a custom download strategy and specify it using the [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) method's `:using` option: +If you need more control over the way files are downloaded and staged, you can create a custom download strategy and specify it using the [`url`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#url-class_method) method's `:using` option: ```ruby @@ -714,11 +714,11 @@ to create the directory structure to the manual page location. To install man pages into specific locations, use `man1.install "foo.1", "bar.1"`, `man2.install "foo.2"`, etc. -Note that in the context of Homebrew, [`libexec`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#libexec-instance_method) is reserved for private use by the formula and therefore is not symlinked into `HOMEBREW_PREFIX`. +Note that in the context of Homebrew, [`libexec`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#libexec-instance_method) is reserved for private use by the formula and therefore is not symlinked into `HOMEBREW_PREFIX`. ## Adding optional steps -If you want to add an [`option`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#option-class_method): +If you want to add an [`option`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#option-class_method): ```ruby class Yourformula < Formula @@ -730,7 +730,7 @@ class Yourformula < Formula ... ``` -And then to define the effects the [`option`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#option-class_method)s have: +And then to define the effects the [`option`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#option-class_method)s have: ```ruby if build.with? "ham" @@ -742,9 +742,9 @@ if build.without? "ham" end ``` -[`option`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#option-class_method) names should be prefixed with the words `with` or `without`. For example, an option to run a test suite should be named `--with-test` or `--with-check` rather than `--test`, and an option to enable a shared library `--with-shared` rather than `--shared` or `--enable-shared`. +[`option`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#option-class_method) names should be prefixed with the words `with` or `without`. For example, an option to run a test suite should be named `--with-test` or `--with-check` rather than `--test`, and an option to enable a shared library `--with-shared` rather than `--shared` or `--enable-shared`. -Note that [`option`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#option-class_method)s that aren’t `build.with? ` or `build.without?` should be deprecated with [`deprecated_option`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#deprecated_option-class_method). See [wget](https://github.com/Homebrew/homebrew-core/blob/master/Formula/wget.rb#L27-L31) for an example. +Note that [`option`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#option-class_method)s that aren’t `build.with? ` or `build.without?` should be deprecated with [`deprecated_option`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#deprecated_option-class_method). See [wget](https://github.com/Homebrew/homebrew-core/blob/master/Formula/wget.rb#L27-L31) for an example. ## File level operations @@ -771,7 +771,7 @@ For example, Ruby 1.9’s gems should be installed to `var/lib/ruby/` so that ge ### launchd plist files -Homebrew provides two Formula methods for launchd plist files. [`plist_name`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#plist_name-instance_method) will return e.g. `homebrew.mxcl.` and [`plist_path`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#plist_path-instance_method) will return e.g. `/usr/local/Cellar/foo/0.1/homebrew.mxcl.foo.plist`. +Homebrew provides two Formula methods for launchd plist files. [`plist_name`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#plist_name-instance_method) will return e.g. `homebrew.mxcl.` and [`plist_path`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#plist_path-instance_method) will return e.g. `/usr/local/Cellar/foo/0.1/homebrew.mxcl.foo.plist`. ## Updating formulae @@ -792,7 +792,7 @@ Homebrew wants to maintain a consistent Ruby style across all formulae based on ### Version detection fails -Homebrew tries to automatically determine the [`version`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#version-class_method) from the [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) in avoid duplication. If the tarball has an unusual name you may need to manually assign the [`version`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#version-class_method). +Homebrew tries to automatically determine the [`version`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#version-class_method) from the [`url`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#url-class_method) in avoid duplication. If the tarball has an unusual name you may need to manually assign the [`version`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#version-class_method). ## Bad Makefiles diff --git a/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md b/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md index b5c6a2ebcd7fe..566b6c5b46b78 100644 --- a/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md +++ b/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md @@ -1,15 +1,15 @@ # How To Open a Homebrew Pull Request (and get it merged) The following commands are used by Homebrew's contributors to setup a fork of Homebrew's Git repository on GitHub, create a new branch and create a GitHub pull request of the changes in that branch. -Depending on the change you want to make, you need to send the pull request to the corresponding repository. If you want to submit a change in Homebrew core code, you should open the pull request at [Homebrew/homebrew](https://github.com/Homebrew/homebrew). If you want to apply any change on formula, you could open the pull request at [Homebrew core tap](https://github.com/Homebrew/homebrew-core) or any other [official taps](https://github.com/Homebrew) based on the nature of related formuale. +Depending on the change you want to make, you need to send the pull request to the corresponding repository. If you want to submit a change in Homebrew core code, you should open the pull request at [Homebrew/brew](https://github.com/Homebrew/brew). If you want to submit a change for a formula, you could open the pull request at [Homebrew core tap](https://github.com/Homebrew/homebrew-core) or any other [official taps](https://github.com/Homebrew) based the formula type. ## Set up your own fork of the Homebrew repository ### Core code related pull request 1. Change to the directory containing your Homebrew installation with `cd $(brew --repository)` -2. [Fork the Homebrew/homebrew repository](https://github.com/Homebrew/homebrew/fork) on GitHub. This creates a pushable, personal remote repository. This is needed as only Homebrew maintainers have push access to the main repository. -3. Add the pushable forked repository with `git remote add YOUR_USERNAME https://github.com/YOUR_USERNAME/homebrew.git` +2. [Fork the Homebrew/brew repository](https://github.com/Homebrew/brew/fork) on GitHub. This creates a pushable, personal remote repository. This is needed as only Homebrew maintainers have push access to the main repository. +3. Add the pushable forked repository with `git remote add YOUR_USERNAME https://github.com/YOUR_USERNAME/brew.git` ### Formulae related pull request diff --git a/share/doc/homebrew/Installation.md b/share/doc/homebrew/Installation.md index 7a55337f4849f..51d86dc2072cb 100644 --- a/share/doc/homebrew/Installation.md +++ b/share/doc/homebrew/Installation.md @@ -29,7 +29,7 @@ not build when installed elsewhere. One of the reasons Homebrew just works relative to the competition is **because** we recommend installing to `/usr/local`. *Pick another prefix at your peril!* -`mkdir homebrew && curl -L https://github.com/Homebrew/homebrew/tarball/master | tar xz --strip 1 -C homebrew` +`mkdir homebrew && curl -L https://github.com/Homebrew/brew/tarball/master | tar xz --strip 1 -C homebrew` ### Multiple installations Create a Homebrew installation wherever you extract the tarball. Whichever brew command is called is where the packages will be installed. You can use this as you see fit, e.g. a system set of libs in `/usr/local` and tweaked formulae for development in `~/homebrew`. diff --git a/share/doc/homebrew/New-Maintainer-Checklist.md b/share/doc/homebrew/New-Maintainer-Checklist.md index ba66b0eff6a68..e3a627bc236d9 100644 --- a/share/doc/homebrew/New-Maintainer-Checklist.md +++ b/share/doc/homebrew/New-Maintainer-Checklist.md @@ -25,8 +25,8 @@ A few requests: - still create your branches on your fork rather than in the main repository - if still in doubt please ask for help and we'll help you out - these are probably worth a read: - - https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md - - https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Maintainer-Guidelines.md + - https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md + - https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Maintainer-Guidelines.md - possibly everything else in the documentation How does that sound? @@ -42,7 +42,7 @@ If they accept, follow a few steps to get them set up: - [x] Add them to the [Jenkins' GitHub Pull Request Builder admin list](http://bot.brew.sh/configure) to enable `@BrewTestBot test this please` for them - [x] Invite them to the [`homebrew-dev` private maintainers mailing list](https://groups.google.com/forum/#!managemembers/homebrew-dev/invite) - [x] Invite them to the [`machomebrew` private maintainers Slack](https://machomebrew.slack.com/admin/invites) -- [x] Add them to [Homebrew's README](https://github.com/Homebrew/homebrew/edit/master/README.md) +- [x] Add them to [Homebrew's README](https://github.com/Homebrew/brew/edit/master/README.md) - [x] Encourage them to enable [GitHub's Two Factor Authentication](https://help.github.com/articles/about-two-factor-authentication/) After a few weeks/months with no problems consider making them [owners on the Homebrew GitHub organisation](https://github.com/orgs/Homebrew/people) and [administrators on Bintray](https://bintray.com/homebrew/organization/edit/members). diff --git a/share/doc/homebrew/Querying-Brew.md b/share/doc/homebrew/Querying-Brew.md index 4b245667cf122..84a2ba4ebd0bf 100644 --- a/share/doc/homebrew/Querying-Brew.md +++ b/share/doc/homebrew/Querying-Brew.md @@ -24,7 +24,7 @@ From the manpage: The current schema version is `v1`. Note that fields may be added to the schema as needed without incrementing the schema. Any significant breaking changes will cause a change to the schema version. -The schema itself is not currently documented outside of the code that generates it: [Formula#to_hash](https://github.com/Homebrew/homebrew/blob/master/Library/Homebrew/formula.rb#L443) +The schema itself is not currently documented outside of the code that generates it: [Formula#to_hash](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/formula.rb) (**TODO**: add a manpage for the schema) diff --git a/share/doc/homebrew/Tips-N'-Tricks.md b/share/doc/homebrew/Tips-N'-Tricks.md index cc97ce7153446..eee552802979d 100644 --- a/share/doc/homebrew/Tips-N'-Tricks.md +++ b/share/doc/homebrew/Tips-N'-Tricks.md @@ -6,11 +6,11 @@ The preferred and supported method of installing specific versions of formulae is to use the [homebrew/versions](https://github.com/Homebrew/homebrew-versions) tap. If the version you’re looking for isn’t available, consider [opening a -pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md)! +pull request](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md)! ### Installing directly from pull-requests -You can browse pull requests https://github.com/Homebrew/homebrew/pulls +You can browse pull requests https://github.com/Homebrew/homebrew-core/pulls and install through the direct link. For example Python 3.3.0 pull request https://github.com/Homebrew/homebrew/pull/15199 ```sh diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index ea6c9465f277d..2997bcb0348d9 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -73,7 +73,7 @@

COMMANDS

and version, but if it fails, you'll have to make your own template. The wget formula serves as a simple example. For the complete API have a look at

-

http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula

+

http://www.rubydoc.info/github/Homebrew/brew/master/Formula

If --autotools is passed, create a basic template for an Autotools-style build. If --cmake is passed, create a basic template for a CMake-style build.

@@ -153,7 +153,7 @@

COMMANDS

information on all installed formulae.

See the docs for examples of using the JSON: -https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md

+https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md

install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source|--force-bottle] [--devel|--HEAD] formula

Install formula.

formula is usually the name of the formula to install, but it can be specified @@ -314,7 +314,7 @@

COMMANDS

Pass --installed to get information on installed taps.

See the docs for examples of using the JSON: -https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md

+https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md

tap-pin tap

Pin tap, prioritizing its formulae over core when formula names are supplied by the user. See also tap-unpin.

tap-unpin tap

Unpin tap so its formulae are no longer prioritized. See also tap-pin.

@@ -402,7 +402,7 @@

EXTERNAL COMMANDS

to create your own commands without modifying Homebrew's internals.

Instructions for creating your own commands can be found in the docs: -https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External-Commands.md

+https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md

SPECIFYING FORMULAE

@@ -527,7 +527,7 @@

USING HOMEBREW BEHIND A PROXY

SEE ALSO

-

Homebrew Documentation: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/

+

Homebrew Documentation: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/

git(1), git-log(1)

@@ -542,7 +542,7 @@

BUGS

See our issues on GitHub:

diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index be2e31150d828..8f1167f317bb1 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -96,7 +96,7 @@ Show Homebrew and system configuration useful for debugging\. If you file a bug Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at . .IP -\fIhttp://www\.rubydoc\.info/github/Homebrew/homebrew/master/Formula\fR +\fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR . .IP If \fB\-\-autotools\fR is passed, create a basic template for an Autotools\-style build\. If \fB\-\-cmake\fR is passed, create a basic template for a CMake\-style build\. @@ -211,7 +211,7 @@ Print a JSON representation of \fIformulae\fR\. Currently the only accepted valu Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\. . .IP -See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR +See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR . .TP \fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR\fIstd\fR|\fIsuper\fR] [\fB\-\-ignore\-dependencies\fR] [\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] \fIformula\fR @@ -442,7 +442,7 @@ Print a JSON representation of \fItaps\fR\. Currently the only accepted value fo Pass \fB\-\-installed\fR to get information on installed taps\. . .IP -See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR +See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying\-Brew\.md\fR . .TP \fBtap\-pin\fR \fItap\fR @@ -577,7 +577,7 @@ Print the version number of brew to standard error and exit\. Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the \fBPATH\fR, named \fBbrew\-\fR\fIcmdname\fR or \fBbrew\-\fR\fIcmdname\fR\fB\.rb\fR, which can be invoked like \fBbrew\fR \fIcmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\. . .P -Instructions for creating your own commands can be found in the docs: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External\-Commands\.md\fR +Instructions for creating your own commands can be found in the docs: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/External\-Commands\.md\fR . .SH "SPECIFYING FORMULAE" Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms: @@ -756,7 +756,7 @@ http_proxy=http://:@: brew install foo .IP "" 0 . .SH "SEE ALSO" -Homebrew Documentation: \fIhttps://github\.com/Homebrew/homebrew/blob/master/share/doc/homebrew/\fR +Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/\fR . .P \fBgit\fR(1), \fBgit\-log\fR(1) @@ -771,9 +771,10 @@ Former maintainers with significant contributions include Jack Nagel, Adam Vande See our issues on GitHub: . .IP "\(bu" 4 -Homebrew \fIhttps://github\.com/Homebrew/homebrew/issues\fR +Homebrew/brew \fIhttps://github\.com/Homebrew/brew/issues\fR . .IP "\(bu" 4 Homebrew/homebrew\-core \fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR . .IP "" 0 +