Use new Homebrew/brew docs paths.
parent
0e0a22a79a
commit
d04e7ad28e
|
@ -6,7 +6,7 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c
|
||||||
|
|
||||||
* run `brew update` (twice)
|
* run `brew update` (twice)
|
||||||
* run and read `brew doctor`
|
* run and read `brew doctor`
|
||||||
* read [the Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting)
|
* read [the Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/docs/Troubleshooting.md#troubleshooting)
|
||||||
* open an issue on the formula's repository
|
* open an issue on the formula's repository
|
||||||
|
|
||||||
### Submit a `1.2.3` version upgrade for the `foo` formula
|
### Submit a `1.2.3` version upgrade for the `foo` formula
|
||||||
|
@ -17,15 +17,15 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c
|
||||||
* `brew install foo`
|
* `brew install foo`
|
||||||
* run `brew audit foo` and fix any issues
|
* run `brew audit foo` and fix any issues
|
||||||
* `git commit` with commit subject `foo 1.2.3`
|
* `git commit` with commit subject `foo 1.2.3`
|
||||||
* [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) and fix any failing tests
|
* [open a pull request](https://github.com/Homebrew/brew/blob/master/docs/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`
|
### Add a new formula for `foo` version `2.3.4` from `$URL`
|
||||||
|
|
||||||
* read [the Formula Cookbook](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook) or: `brew create $URL` and make edits
|
* read [the Formula Cookbook](https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md#formula-cookbook) or: `brew create $URL` and make edits
|
||||||
* `brew install foo`
|
* `brew install foo`
|
||||||
* `brew audit --online --strict foo`
|
* `brew audit --online --strict foo`
|
||||||
* `git commit` with message formatted `foo 2.3.4 (new formula)`
|
* `git commit` with message formatted `foo 2.3.4 (new formula)`
|
||||||
* [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) and fix any failing tests
|
* [open a pull request](https://github.com/Homebrew/brew/blob/master/docs/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
|
### Contribute a fix to the `foo` formula
|
||||||
|
|
||||||
|
@ -33,6 +33,6 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c
|
||||||
* leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#bottle-class_method) as-is
|
* leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/brew/master/Formula#bottle-class_method) as-is
|
||||||
* `brew install foo`, `brew test foo`, and `brew audit foo`
|
* `brew install foo`, `brew test foo`, and `brew audit foo`
|
||||||
* `git commit` with message formatted `foo: fix <insert details>`
|
* `git commit` with message formatted `foo: fix <insert details>`
|
||||||
* [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) and fix any failing tests
|
* [open a pull request](https://github.com/Homebrew/brew/blob/master/docs/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!
|
Thanks!
|
||||||
|
|
|
@ -133,7 +133,7 @@ class Pypy < Formula
|
||||||
To update setuptools and pip between pypy releases, run:
|
To update setuptools and pip between pypy releases, run:
|
||||||
pip_pypy install --upgrade pip setuptools
|
pip_pypy install --upgrade pip setuptools
|
||||||
|
|
||||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
See: https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md
|
||||||
EOS
|
EOS
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -112,7 +112,7 @@ class Pypy3 < Formula
|
||||||
To update pip and setuptools between pypy3 releases, run:
|
To update pip and setuptools between pypy3 releases, run:
|
||||||
pip_pypy3 install --upgrade pip setuptools
|
pip_pypy3 install --upgrade pip setuptools
|
||||||
|
|
||||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
See: https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md
|
||||||
EOS
|
EOS
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -285,7 +285,7 @@ class Python < Formula
|
||||||
<<-EOF.undent
|
<<-EOF.undent
|
||||||
# This file is created by Homebrew and is executed on each python startup.
|
# This file is created by Homebrew and is executed on each python startup.
|
||||||
# Don't print from here, or else python command line scripts may fail!
|
# Don't print from here, or else python command line scripts may fail!
|
||||||
# <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md>
|
# <https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md>
|
||||||
import re
|
import re
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
@ -341,7 +341,7 @@ class Python < Formula
|
||||||
They will install into the site-package directory
|
They will install into the site-package directory
|
||||||
#{site_packages}
|
#{site_packages}
|
||||||
|
|
||||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
See: https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md
|
||||||
EOS
|
EOS
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -307,7 +307,7 @@ class Python3 < Formula
|
||||||
<<-EOF.undent
|
<<-EOF.undent
|
||||||
# This file is created by Homebrew and is executed on each python startup.
|
# This file is created by Homebrew and is executed on each python startup.
|
||||||
# Don't print from here, or else python command line scripts may fail!
|
# Don't print from here, or else python command line scripts may fail!
|
||||||
# <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md>
|
# <https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md>
|
||||||
import re
|
import re
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
@ -352,7 +352,7 @@ class Python3 < Formula
|
||||||
They will install into the site-package directory
|
They will install into the site-package directory
|
||||||
#{site_packages}
|
#{site_packages}
|
||||||
|
|
||||||
See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Homebrew-and-Python.md
|
See: https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md
|
||||||
EOS
|
EOS
|
||||||
|
|
||||||
# Tk warning only for 10.6
|
# Tk warning only for 10.6
|
||||||
|
|
|
@ -13,7 +13,7 @@ Just `brew install <formula>`. This is the default tap for Homebrew and is insta
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
First, please run `brew update` (twice) and `brew doctor`.
|
First, please run `brew update` (twice) and `brew doctor`.
|
||||||
|
|
||||||
Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting).
|
Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/brew/blob/master/docs/Troubleshooting.md#troubleshooting).
|
||||||
|
|
||||||
**If you don’t read these it will take us far longer to help you with your problem.**
|
**If you don’t read these it will take us far longer to help you with your problem.**
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue