Update documentation after repository split.

raj347 · Apr 3, 2016 · 276a797 · 276a797
1 parent d127569
commit 276a797
Show file tree

Hide file tree

Showing 24 changed files with 102 additions and 143 deletions.
diff --git 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 <insert details>`
-* [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
@@ -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 <formula>`
-(where `<formula>` 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
@@ -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 <formula>` (where `<formula>` is the name of the formula you're submitting)?
-- [ ] Have you built your formula locally prior to submission with `brew install <formula>`?
-
-### 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
 
-    <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.
@@ -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:
-    <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>.
@@ -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:
-    <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
@@ -543,7 +543,7 @@ scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or
 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
 
@@ -714,7 +714,7 @@ If your proxy requires authentication:
 
 ## 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)
 
@@ -728,6 +728,6 @@ Former maintainers with significant contributions include Jack Nagel, Adam Vande
 
 See our issues on GitHub:
 
- * Homebrew <https://github.com/Homebrew/homebrew/issues>
+ * Homebrew/brew <https://github.com/Homebrew/brew/issues>
 
  * Homebrew/homebrew-core <https://github.com/Homebrew/homebrew-core/issues>
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -95,4 +95,4 @@ These commands have been contributed by Homebrew users but are not included in t
 > ```
 
 ## SEE ALSO
-Homebrew Docs: <https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew>
+Homebrew Docs: <https://github.com/Homebrew/brew/tree/master/share/doc/homebrew>