mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
Fix broken or inactive URLs
Bare URLs are auto-linked on GitHub but not on docs.brew.sh, so I added angle brackets around them where appropriate. Also converted Markdown-linked URLs for clarity.
This commit is contained in:
parent
c7121f6be5
commit
20bb0aae80
@ -4,13 +4,13 @@ If a build has run and passed on `brew test-bot` then it can be used to quickly
|
||||
|
||||
There are two types of Jenkins jobs you will interact with:
|
||||
|
||||
## [Homebrew Pull Requests](https://bot.brew.sh/job/Homebrew%20Core%20Pull%20Requests/)
|
||||
## [Homebrew Core Pull Requests](https://bot.brew.sh/job/Homebrew%20Core/)
|
||||
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 documentation page](Brew-Test-Bot.md)). On a successful build it automatically uploads bottles.
|
||||
|
||||
## [Homebrew Testing](https://bot.brew.sh/job/Homebrew%20Testing/)
|
||||
This job is manually triggered to run [`brew test-bot`](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/dev-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/homebrew-test-bot/blob/master/cmd/brew-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/brew/blob/master/Library/Homebrew/dev-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/homebrew-test-bot/blob/master/cmd/brew-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`:
|
||||
|
@ -5,7 +5,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 https://bot.brew.sh](https://bot.brew.sh) and run the
|
||||
[`brew test-bot.rb`](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/dev-cmd/test-bot.rb)
|
||||
[`brew test-bot.rb`](https://github.com/Homebrew/homebrew-test-bot/blob/master/cmd/brew-test-bot.rb)
|
||||
Ruby script to perform automated testing of commits to the master branch, pull
|
||||
requests and custom builds requested by maintainers.
|
||||
|
||||
|
@ -7,8 +7,7 @@ You need to have the Xcode Command Line Utilities installed (and updated): run `
|
||||
(In OS X prior to 10.9, the "Command Line Tools" package can alternatively be installed from within Xcode. `⌘,` will get you to preferences. Visit the "Downloads" tab and hit the install button next to "Command Line Tools".)
|
||||
|
||||
### Ruby `bad interpreter: /usr/bin/ruby^M: no such file or directory`
|
||||
You cloned with git, and your git configuration is set to use Windows line endings. See this page: https://help.github.com/articles/dealing-with-line-endings
|
||||
|
||||
You cloned with git, and your git configuration is set to use Windows line endings. See this page: <https://help.github.com/articles/dealing-with-line-endings>
|
||||
|
||||
### Ruby `bad interpreter: /usr/bin/ruby`
|
||||
You don't have a `/usr/bin/ruby` or it is not executable. It's not recommended to let this persist, you'd be surprised how many .apps, tools and scripts expect your macOS provided files and directories to be *unmodified* since macOS was installed.
|
||||
|
@ -47,15 +47,15 @@ brew tap youtux/livecheck
|
||||
```
|
||||
|
||||
### brew-gem
|
||||
Install any gem package into a self-contained Homebrew cellar location: [https://github.com/sportngin/brew-gem](https://github.com/sportngin/brew-gem).
|
||||
Install any gem package into a self-contained Homebrew cellar location: <https://github.com/sportngin/brew-gem>
|
||||
|
||||
Note this can also be installed with `brew install brew-gem`.
|
||||
|
||||
### brew-growl
|
||||
Get Growl notifications for Homebrew https://github.com/secondplanet/brew-growl
|
||||
Get Growl notifications for Homebrew: <https://github.com/secondplanet/homebrew-growl>
|
||||
|
||||
### brew-services
|
||||
Simple support to start formulae using launchctl, has out of the box support for any formula which defines `startup_plist` (e.g. mysql, postgres, redis u.v.m.): [https://github.com/Homebrew/homebrew-services](https://github.com/Homebrew/homebrew-services)
|
||||
Simple support to start formulae using launchctl, has out of the box support for any formula which defines `startup_plist` (e.g. mysql, postgres, redis u.v.m.): <https://github.com/Homebrew/homebrew-services>
|
||||
|
||||
Install using:
|
||||
```sh
|
||||
|
@ -81,13 +81,12 @@ including how to set this across reboots. If you’re pre-Mountain Lion,
|
||||
alternative](https://developer.apple.com/legacy/library/qa/qa1067/_index.html).
|
||||
|
||||
## How do I contribute to Homebrew?
|
||||
Read [CONTRIBUTING.md](/CONTRIBUTING.md).
|
||||
Read [CONTRIBUTING.md](https://github.com/Homebrew/brew/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Why do you compile everything?
|
||||
Homebrew provides pre-compiled versions for many formulae. These
|
||||
pre-compiled versions are referred to as **bottles** and are available
|
||||
at:
|
||||
[https://bintray.com/homebrew/bottles](https://bintray.com/homebrew/bottles).
|
||||
at <https://bintray.com/homebrew/bottles>.
|
||||
|
||||
If available, bottled binaries will be used by default except under the
|
||||
following conditions:
|
||||
|
@ -58,7 +58,7 @@ Homebrew builds bindings against the first `python` (and `python-config`) in you
|
||||
**Warning!** Python may crash (see [Common Issues](Common-Issues.md)) if you `import <module>` from a brewed Python if you ran `brew install <formula_with_python_bindings>` against the system Python. If you decide to switch to the brewed Python, then reinstall all formulae with python bindings (e.g. `pyside`, `wxwidgets`, `pygtk`, `pygobject`, `opencv`, `vtk` and `boost-python`).
|
||||
|
||||
## Policy for non-brewed Python bindings
|
||||
These should be installed via `pip install <x>`. To discover, you can use `pip search` or <https://pypi.python.org/pypi>. (**Note:** System Python does not provide `pip`. Follow the instructions at https://pip.readthedocs.org/en/stable/installing/#install-pip to install it for your system Python if you would like it.)
|
||||
These should be installed via `pip install <x>`. To discover, you can use `pip search` or <https://pypi.python.org/pypi>. (**Note:** System Python does not provide `pip`. Follow the instructions at <https://pip.readthedocs.io/en/stable/installing/#install-pip> to install it for your system Python if you would like it.)
|
||||
|
||||
|
||||
## Brewed Python modules
|
||||
|
@ -43,7 +43,7 @@ To make a new branch and submit it for review, create a GitHub pull request with
|
||||
4. `brew audit --strict <CHANGED_FORMULA>`
|
||||
6. Make a separate commit for each changed formula with `git add` and `git commit`.
|
||||
7. Upload your new commits to the branch on your fork with `git push --set-upstream <YOUR_USERNAME> <YOUR_BRANCH_NAME>`.
|
||||
8. Go to the relevant repository (e.g. https://github.com/Homebrew/brew, https://github.com/Homebrew/homebrew-core, etc.) and create a pull request to request review and merging of the commits in your pushed branch. Explain why the change is needed and, if fixing a bug, how to reproduce the bug. Make sure you have done each step in the checklist that appears in your new PR.
|
||||
8. Go to the relevant repository (e.g. <https://github.com/Homebrew/brew>, <https://github.com/Homebrew/homebrew-core>, etc.) and create a pull request to request review and merging of the commits in your pushed branch. Explain why the change is needed and, if fixing a bug, how to reproduce the bug. Make sure you have done each step in the checklist that appears in your new PR.
|
||||
* Please note that our preferred commit message format for simple version updates is "`<FORMULA_NAME> <NEW_VERSION>`", e.g. "`source-highlight 3.1.8`". `devel` version updates should have the commit message suffixed with `(devel)`, e.g. "`nginx 1.9.1 (devel)`". If updating both stable and `devel`, the format should be a concatenation of these two forms, e.g. "`x264 r2699, r2705 (devel)`".
|
||||
9. Await feedback or a merge from Homebrew's maintainers. We typically respond to all PRs within a couple days, but it may take up to a week, depending on the maintainers' workload.
|
||||
10. Thank you!
|
||||
|
@ -1,7 +1,7 @@
|
||||
# Interesting Taps & Forks
|
||||
|
||||
A Tap is homebrew-speak for a git repository containing extra formulae.
|
||||
Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` command. Type `man brew` in your Terminal. The main repository https://github.com/Homebrew/homebrew-core, often called `homebrew/core`, is always built-in.
|
||||
Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` command. Type `man brew` in your Terminal. The main repository <https://github.com/Homebrew/homebrew-core>, often called `homebrew/core`, is always built-in.
|
||||
|
||||
## Main Taps
|
||||
|
||||
|
@ -213,7 +213,7 @@ Distribute (not to be confused with distutils) is an obsolete fork of setuptools
|
||||
|
||||
## What is `--single-version-externally-managed`?
|
||||
|
||||
`--single-version-externally-managed` ("SVEM") is a setuptools-only [argument to setup.py install](https://pythonhosted.org/setuptools/setuptools.html#install-run-easy-install-or-old-style-installation). The primary effect of SVEM is to use distutils to perform the install instead of using setuptools' `easy_install`.
|
||||
`--single-version-externally-managed` ("SVEM") is a setuptools-only [argument to setup.py install](http://setuptools.readthedocs.io/en/latest/setuptools.html?#install-run-easy-install-or-old-style-installation). The primary effect of SVEM is to use distutils to perform the install instead of using setuptools' `easy_install`.
|
||||
|
||||
`easy_install` does a few things that we need to avoid:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user