admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

General documentation updates.

Browse Source 
Mostly related to the newer ways we’re handling versions and the
incoming deprecation of devel-only, head-only and versions.
This commit is contained in:
Mike McQuaid 2017-01-02 18:29:00 +00:00
parent 2eed2ba434
commit 91c09c5b11
7 changed files with 11 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Acceptable-Formulae.md
View File

@ -67,12 +67,8 @@ Formulae in the core repository must have a stable version tagged by
the upstream project. Tarballs are preferred to git checkouts, and
tarballs should include the version in the filename whenever possible.
Software that only provides a development/beta, tagged version should be put in
[homebrew/devel-only](https://github.com/Homebrew/homebrew-devel-only).
We don’t accept software without a tagged version because they regularly break
due to upstream changes; we can’t provide [bottles](Bottles.md) for them; and
we don’t have an automatic update mechanism for `head-only` formulae which
makes them very quickly outdated.
due to upstream changes and we can’t provide [bottles](Bottles.md) for them.
### Bindings
First check that there is not already a binding available via

3
docs/Custom-GCC-and-cross-compilers.md
View File

@ -15,7 +15,6 @@ GCC or cross-compiler suite, please link it in here.
* Homebrew provides a `gcc` formula for use with Xcode 4.2+ or when needing
C++11 support on earlier versions.
* [Homebrew-versions](https://github.com/homebrew/homebrew-versions) provides an
up to date GCC duplicates e.g. `brew install homebrew/versions/gcc48`
* Homebrew provides older GCC formulae e.g. `gcc@4.8` and `gcc@6`
* [RISC-V](https://github.com/riscv/homebrew-riscv) provides the RISC-V
toolchain including binutils and gcc.

19
docs/FAQ.md
View File

@ -212,23 +212,8 @@ Linking /usr/local/Cellar/foo/0.1… 17 symlinks created
```
### Where was a formula deleted?
Use `brew log $FORMULA` to find out!
Sometimes formulae are moved to specialized repositories. These are the
likely candidates:
* [homebrew/dupes](https://github.com/Homebrew/homebrew-dupes)
* [homebrew/games](https://github.com/Homebrew/homebrew-games)
* [homebrew/versions](https://github.com/Homebrew/homebrew-versions)
You can use `brew tap` to access these formulae:
```bash
brew tap homebrew/games
brew install …
```
Note that brew search still finds formula in taps.
Use `brew log $FORMULA` to find out! Likely because it had unresolved issues or
our analytics identified it was not widely used.
### Homebrew is a poor name, it is generic, why was it chosen?
@mxcl was too concerned with the beer theme and didn’t consider that the

6
docs/Formula-Cookbook.md
View File

@ -9,11 +9,11 @@ A formula is a package definition written in Ruby. It can be created with `brew
| **Keg** | The installation prefix of a **Formula** | `/usr/local/Cellar/foo/0.1` |
| **opt prefix** | A symlink to the active version of a **Keg** | `/usr/local/opt/foo ` |
| **Cellar** | All **Kegs** are installed here | `/usr/local/Cellar` |
| **Tap** | An optional Git repository of **Formulae** and/or commands | `/usr/local/Homebrew/Library/Taps/homebrew/homebrew-versions` |
| **Tap** | An Git repository of **Formulae** and/or commands | `/usr/local/Homebrew/Library/Taps/homebrew/homebrew-core` |
| **Bottle** | Pre-built **Keg** used instead of building from source | `qt-4.8.4.mavericks.bottle.tar.gz` |
| **Cask** | An [extension of homebrew](https://github.com/caskroom/homebrew-cask) to install macOS native apps | `/Applications/MacDown.app/Contents/SharedSupport/bin/macdown` |
| **Brew Bundle**| An [extension of homebrew](https://github.com/Homebrew/homebrew-bundle) to describe dependencies | `brew 'myservice', restart_service: true` |
## An Introduction
Homebrew uses Git for downloading updates and contributing to the project.
@ -33,7 +33,7 @@ Before submitting a new formula make sure your package:
* isn't in another official [Homebrew tap](https://github.com/Homebrew)
* isn't already waiting to be merged (check the [issue tracker](https://github.com/Homebrew/homebrew-core/pulls))
* is still supported by upstream (i.e. doesn't require extensive patching)
* has a stable, tagged version (i.e. not just a GitHub repository with no versions). See [Interesting-Taps-&-Forks](Interesting-Taps-&-Forks.md) for where pre-release versions belong.
* has a stable, tagged version (i.e. not just a GitHub repository with no versions).
* passes all `brew audit --new-formula $FORMULA` tests.
Before submitting a new formula make sure you read over our [contribution guidelines](https://github.com/Homebrew/brew/blob/master/CONTRIBUTING.md).

3
docs/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md
View File

@ -4,6 +4,9 @@ The following commands are used by Homebrew contributors to set up a fork of Hom
Depending on the change you want to make, you need to send the pull request to the appropriate one of Homebrew's main repositories. If you want to submit a change to Homebrew core code (the `brew` implementation), you should open the pull request on [Homebrew/brew](https://github.com/Homebrew/brew). If you want to submit a change for a formula, you should open the pull request on [the `homebrew/core` tap](https://github.com/Homebrew/homebrew-core) or another [official tap](https://github.com/Homebrew), based on the formula type.
## Submit a new version of an existing formula
1. Use `brew bump-formula-pr` to do everything (i.e. forking, committing, pushing) with a single command. Run `brew bump-formula-pr --help` to learn more.
## Set up your own fork of the Homebrew repository
### Core `brew` code related pull request

6
docs/Interesting-Taps-&-Forks.md
View File

@ -12,16 +12,12 @@ Homebrew has the capability to add (and remove) multiple taps to your local inst
* [homebrew/completions](https://github.com/Homebrew/homebrew-completions): Shell completion formulae.
* [homebrew/devel-only](https://github.com/Homebrew/homebrew-devel-only): A tap for brews that only have pre-release/development versions.
* [homebrew/dupes](https://github.com/Homebrew/homebrew-dupes): Need GDB or a newer Tk? System duplicates go here.
* [homebrew/emacs](https://github.com/Homebrew/homebrew-emacs): A tap for Emacs packages.
* [homebrew/games](https://github.com/Homebrew/homebrew-games): Game or gaming-emulation related formulae.
* [homebrew/head-only](https://github.com/Homebrew/homebrew-head-only): A tap for brews that only have unstable, unreleased versions. This tap is **deprecated** and doesn’t accept new formulae.
* [homebrew/nginx](https://github.com/Homebrew/homebrew-nginx): Feature rich Nginx tap for modules.
* [homebrew/php](https://github.com/Homebrew/homebrew-php): Repository for php-related formulae.
@ -32,8 +28,6 @@ Homebrew has the capability to add (and remove) multiple taps to your local inst
* [homebrew/services](https://github.com/Homebrew/homebrew-services): A tool to start Homebrew formulae's plists with `launchctl`.
* [homebrew/versions](https://github.com/Homebrew/homebrew-versions): Need e.g. older or newer versions of Postgresql? Older versions of GCC?
* [homebrew/x11](https://github.com/Homebrew/homebrew-x11): Formulae with hard X11 dependencies.
`brew search` looks in these main taps as well as in [homebrew/core](https://github.com/Homebrew/homebrew-core). So don't worry about missing stuff. We will add other taps to the search as they become well maintained and popular.

4
docs/Tips-N'-Tricks.md
View File

@ -3,9 +3,7 @@
## Installing previous versions of formulae
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
formulae is to use formula like e.g. `gcc@6`. If the version you’re looking for isn’t available, consider [opening a
pull request](https://github.com/Homebrew/brew/blob/master/docs/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md)!
### Installing directly from pull-requests