Merge pull request #1031 from MikeMcQuaid/rearrange-repo

Rearrange repository
This commit is contained in:
Mike McQuaid 2016-09-20 10:58:55 +01:00 committed by GitHub
commit 5b9a43a370
67 changed files with 57 additions and 66 deletions

19
.gitignore vendored
View File

@ -33,30 +33,19 @@
# Unignore our `brew` script. # Unignore our `brew` script.
!/bin/brew !/bin/brew
# Ignore `share` contents (again).
/share
/share/doc
/share/zsh
/share/zsh/site-functions
# Unignore our documentation. # Unignore our documentation.
!/.github !/.github
!/share/doc/homebrew !/docs
!/share/man/man1/brew.1 !/manpages
!/share/man/man1/brew-cask.1
# Ignore `etc` contents (again)
/etc
/etc/bash_completion.d
# Unignore our shell completion # Unignore our shell completion
!/etc/bash_completion.d/brew !/completions
!/share/zsh/site-functions/_brew
# Unignore our root-level metadata files. # Unignore our root-level metadata files.
!/.gitignore !/.gitignore
!/.travis.yml !/.travis.yml
!/.yardopts !/.yardopts
!/CODEOFCONDUCT.md !/CODEOFCONDUCT.md
!/CONTRIBUTING.md
!/LICENSE.txt !/LICENSE.txt
!/README.md !/README.md

View File

@ -5,7 +5,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
### Propose a feature ### Propose a feature

View File

@ -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. 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/brew/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/docs/Formula-Cookbook.md) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae.
Good luck! Good luck!

View File

@ -6,7 +6,7 @@ Homebrew-Cask extends [Homebrew](http://brew.sh) and brings its elegance, simpli
We do this by providing a friendly Homebrew-style CLI workflow for the administration of macOS applications distributed as binaries. We do this by providing a friendly Homebrew-style CLI workflow for the administration of macOS applications distributed as binaries.
Its implemented as a `homebrew` [external command](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md) called `cask`. Its implemented as a `homebrew` [external command](https://github.com/Homebrew/brew/blob/master/docs/External-Commands.md) called `cask`.
[![Join the chat at https://gitter.im/caskroom/homebrew-cask](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/caskroom/homebrew-cask) [![Join the chat at https://gitter.im/caskroom/homebrew-cask](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/caskroom/homebrew-cask)

View File

@ -16,7 +16,7 @@ Troubleshooting:
Developers: Developers:
brew create [URL [--no-fetch]] brew create [URL [--no-fetch]]
brew edit [FORMULA...] brew edit [FORMULA...]
https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md
Further help: Further help:
man brew man brew

View File

@ -14,7 +14,7 @@
#: information on all installed formulae. #: information on all installed formulae.
#: #:
#: See the docs for examples of using the JSON: #: See the docs for examples of using the JSON:
#: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md> #: <https://github.com/Homebrew/brew/blob/master/docs/Querying-Brew.md>
require "blacklist" require "blacklist"
require "caveats" require "caveats"

View File

@ -64,6 +64,8 @@ module Homebrew
UNBREWED_EXCLUDE_PATHS = %w[ UNBREWED_EXCLUDE_PATHS = %w[
.github/* .github/*
bin/brew bin/brew
completions/zsh/_brew
docs/*
lib/gdk-pixbuf-2.0/* lib/gdk-pixbuf-2.0/*
lib/gio/* lib/gio/*
lib/node_modules/* lib/node_modules/*
@ -73,13 +75,11 @@ module Homebrew
lib/ruby/gems/[12].* lib/ruby/gems/[12].*
lib/ruby/site_ruby/[12].* lib/ruby/site_ruby/[12].*
lib/ruby/vendor_ruby/[12].* lib/ruby/vendor_ruby/[12].*
manpages/brew.1
share/pypy/* share/pypy/*
share/pypy3/* share/pypy3/*
share/doc/homebrew/*
share/info/dir share/info/dir
share/man/man1/brew.1
share/man/whatis share/man/whatis
share/zsh/site-functions/_brew
].freeze ].freeze
def list_unbrewed def list_unbrewed

View File

@ -13,7 +13,7 @@
#: Pass `--installed` to get information on installed taps. #: Pass `--installed` to get information on installed taps.
#: #:
#: See the docs for examples of using the JSON: #: See the docs for examples of using the JSON:
#: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md> #: <https://github.com/Homebrew/brew/blob/master/docs/Querying-Brew.md>
require "tap" require "tap"

View File

@ -294,15 +294,15 @@ module Homebrew
end end
def link_completions_and_docs(repository = HOMEBREW_REPOSITORY) def link_completions_and_docs(repository = HOMEBREW_REPOSITORY)
return if HOMEBREW_PREFIX.to_s == repository.to_s
command = "brew update" command = "brew update"
link_src_dst_dirs(repository/"etc/bash_completion.d", link_src_dst_dirs(repository/"completions/bash",
HOMEBREW_PREFIX/"etc/bash_completion.d", command) HOMEBREW_PREFIX/"etc/bash_completion.d", command)
link_src_dst_dirs(repository/"share/doc/homebrew", link_src_dst_dirs(repository/"docs",
HOMEBREW_PREFIX/"share/doc/homebrew", command, link_dir: true) HOMEBREW_PREFIX/"share/doc/homebrew", command, link_dir: true)
link_src_dst_dirs(repository/"share/zsh/site-functions", link_src_dst_dirs(repository/"completions/zsh",
HOMEBREW_PREFIX/"share/zsh/site-functions", command) HOMEBREW_PREFIX/"share/zsh/site-functions", command)
link_path_manpages(repository/"share", command) link_src_dst_dirs(repository/"manpages",
HOMEBREW_PREFIX/"share/man/man1", command)
rescue => e rescue => e
ofail <<-EOS.undent ofail <<-EOS.undent
Failed to link all completions, docs and manpages: Failed to link all completions, docs and manpages:

View File

@ -154,7 +154,7 @@ class FormulaCreator
end end
def template; <<-EOS.undent def template; <<-EOS.undent
# Documentation: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md # Documentation: https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md
# http://www.rubydoc.info/github/Homebrew/brew/master/Formula # http://www.rubydoc.info/github/Homebrew/brew/master/Formula
# PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST! # PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!

View File

@ -7,8 +7,8 @@ require "ostruct"
module Homebrew module Homebrew
SOURCE_PATH = HOMEBREW_LIBRARY_PATH/"manpages" SOURCE_PATH = HOMEBREW_LIBRARY_PATH/"manpages"
TARGET_MAN_PATH = HOMEBREW_REPOSITORY/"share/man/man1" TARGET_MAN_PATH = HOMEBREW_REPOSITORY/"manpages"
TARGET_DOC_PATH = HOMEBREW_REPOSITORY/"share/doc/homebrew" TARGET_DOC_PATH = HOMEBREW_REPOSITORY/"docs"
def man def man
raise UsageError unless ARGV.named.empty? raise UsageError unless ARGV.named.empty?

View File

@ -24,7 +24,7 @@ module Homebrew
``` ```
## Documentation ## Documentation
`brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme). `brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/docs#readme).
EOS EOS
puts template if ARGV.verbose? puts template if ARGV.verbose?

View File

@ -26,7 +26,7 @@ require "migrator"
# @see SharedEnvExtension # @see SharedEnvExtension
# @see FileUtils # @see FileUtils
# @see Pathname # @see Pathname
# @see http://www.rubydoc.info/github/Homebrew/brew/file/share/doc/homebrew/Formula-Cookbook.md Formula Cookbook # @see http://www.rubydoc.info/github/Homebrew/brew/file/docs/Formula-Cookbook.md Formula Cookbook
# @see https://github.com/styleguide/ruby Ruby Style Guide # @see https://github.com/styleguide/ruby Ruby Style Guide
# #
# <pre>class Wget < Formula # <pre>class Wget < Formula
@ -1973,7 +1973,7 @@ class Formula
# and you haven't passed or previously used any options on this formula. # 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. # If you maintain your own repository, you can add your own bottle links.
# https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Bottles.md # https://github.com/Homebrew/brew/blob/master/docs/Bottles.md
# You can ignore this block entirely if submitting to Homebrew/Homebrew, It'll be # You can ignore this block entirely if submitting to Homebrew/Homebrew, It'll be
# handled for you by the Brew Test Bot. # handled for you by the Brew Test Bot.
# #

View File

@ -62,7 +62,7 @@ scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or
to create your own commands without modifying Homebrew's internals. to create your own commands without modifying Homebrew's internals.
Instructions for creating your own commands can be found in the docs: Instructions for creating your own commands can be found in the docs:
<https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md> <https://github.com/Homebrew/brew/blob/master/docs/External-Commands.md>
## SPECIFYING FORMULAE ## SPECIFYING FORMULAE
@ -183,7 +183,7 @@ can take several different forms:
*Default:* the number of available CPU cores. *Default:* the number of available CPU cores.
* `HOMEBREW_NO_ANALYTICS`: * `HOMEBREW_NO_ANALYTICS`:
If set, Homebrew will not send analytics. See: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics> If set, Homebrew will not send analytics. See: <https://github.com/Homebrew/brew/blob/master/docs/Analytics.md#analytics>
* `HOMEBREW_NO_AUTO_UPDATE`: * `HOMEBREW_NO_AUTO_UPDATE`:
If set, Homebrew will not auto-update before running `brew install`, If set, Homebrew will not auto-update before running `brew install`,
@ -249,7 +249,7 @@ If your proxy requires authentication:
## SEE ALSO ## SEE ALSO
Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/> Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/docs/>
`git`(1), `git-log`(1) `git`(1), `git-log`(1)

View File

@ -19,7 +19,7 @@ class BashTests < Homebrew::TestCase
end end
def test_bash_completion def test_bash_completion
script = HOMEBREW_LIBRARY_PATH.parent.parent/"etc/bash_completion.d/brew" script = HOMEBREW_LIBRARY_PATH.parent.parent/"completions/bash/brew"
assert_valid_bash_syntax script assert_valid_bash_syntax script
end end

View File

@ -605,8 +605,11 @@ def link_src_dst_dirs(src_dir, dst_dir, command, link_dir: false)
src_paths = link_dir ? [src_dir] : src_dir.find src_paths = link_dir ? [src_dir] : src_dir.find
src_paths.each do |src| src_paths.each do |src|
next if src.directory? && !link_dir next if src.directory? && !link_dir
dst = dst_dir.parent/src.relative_path_from(src_dir.parent) dst = dst_dir/src.relative_path_from(src_dir)
next if dst.symlink? && src == dst.resolved_path if dst.symlink?
next if src == dst.resolved_path
dst.unlink
end
if dst.exist? if dst.exist?
conflicts << dst conflicts << dst
next next

View File

@ -35,7 +35,7 @@ module Utils
end end
# Send analytics. Don't send or store any personally identifiable information. # Send analytics. Don't send or store any personally identifiable information.
# https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md # https://github.com/Homebrew/brew/blob/master/docs/Analytics.md
# https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide
# https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters # https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
if ENV["HOMEBREW_ANALYTICS_DEBUG"] if ENV["HOMEBREW_ANALYTICS_DEBUG"]

View File

@ -104,7 +104,7 @@ report-analytics-screenview-command() {
) )
# Send analytics. Don't send or store any personally identifiable information. # Send analytics. Don't send or store any personally identifiable information.
# https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md # https://github.com/Homebrew/brew/blob/master/docs/Analytics.md
# https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#screenView # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#screenView
# https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters # https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
if [[ -z "$HOMEBREW_ANALYTICS_DEBUG" ]] if [[ -z "$HOMEBREW_ANALYTICS_DEBUG" ]]

View File

@ -13,12 +13,12 @@ cd "$(brew --repo)" && git fetch && git reset --hard origin/master && brew updat
3. Or use `brew search --desc <keyword>` to browse packages from the command line. 3. Or use `brew search --desc <keyword>` to browse packages from the command line.
## More Documentation ## More Documentation
`brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/brew/tree/master/share/doc/homebrew#readme). `brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/brew/tree/master/docs#readme).
## Troubleshooting ## Troubleshooting
First, please run `brew update` and `brew doctor`. First, please run `brew update` 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.**
@ -27,7 +27,7 @@ We'd love you to contribute to Homebrew. First, please read our [Contribution Gu
We explicitly welcome contributions from people who have never contributed to open-source before: we were all beginners once! We can help build on a partially working pull request with the aim of getting it merged. We are also actively seeking to diversify our contributors and especially welcome contributions from women from all backgrounds and people of colour. We explicitly welcome contributions from people who have never contributed to open-source before: we were all beginners once! We can help build on a partially working pull request with the aim of getting it merged. We are also actively seeking to diversify our contributors and especially welcome contributions from women from all backgrounds and people of colour.
A good starting point for contributing is running `brew audit` (or `brew audit --strict`) with some of the packages you use (e.g. `brew audit wget` if you use `wget`) and then read through the warnings, try to fix them until `brew audit` shows no results and [submit 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). If no formulae you use have warnings you can run `brew audit` without arguments to have it run on all packages and pick one. Good luck! A good starting point for contributing is running `brew audit` (or `brew audit --strict`) with some of the packages you use (e.g. `brew audit wget` if you use `wget`) and then read through the warnings, try to fix them until `brew audit` shows no results and [submit a pull request](https://github.com/Homebrew/brew/blob/master/docs/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md). If no formulae you use have warnings you can run `brew audit` without arguments to have it run on all packages and pick one. Good luck!
## Security ## Security
Please report security issues to security@brew.sh. Please report security issues to security@brew.sh.
@ -63,7 +63,7 @@ Homebrew is a member of the [Software Freedom Conservancy](http://sfconservancy.
- Donate with Flattr or PayPal Giving Fund: coming soon. - Donate with Flattr or PayPal Giving Fund: coming soon.
## Sponsors ## Sponsors
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 was paid for by [our Kickstarter supporters](https://github.com/Homebrew/brew/blob/master/docs/Kickstarter-Supporters.md).
Our CI infrastructure is hosted by [The Positive Internet Company](http://www.positive-internet.com). Our CI infrastructure is hosted by [The Positive Internet Company](http://www.positive-internet.com).

View File

@ -76,7 +76,7 @@ When running `brew upgrade`, you see something like this:
$ brew upgrade $ brew upgrade
Error: undefined method `include?' for nil:NilClass Error: undefined method `include?' for nil:NilClass
Please report this bug: Please report this bug:
https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Troubleshooting.md https://github.com/Homebrew/brew/blob/master/docs/Troubleshooting.md
/usr/local/Library/Homebrew/formula.rb:393:in `canonical_name' /usr/local/Library/Homebrew/formula.rb:393:in `canonical_name'
/usr/local/Library/Homebrew/formula.rb:425:in `factory' /usr/local/Library/Homebrew/formula.rb:425:in `factory'
/usr/local/Library/Contributions/examples/brew-upgrade.rb:7 /usr/local/Library/Contributions/examples/brew-upgrade.rb:7

View File

@ -81,4 +81,4 @@ These commands have been contributed by Homebrew users but are not included in t
> ``` > ```
## SEE ALSO ## SEE ALSO
Homebrew Docs: <https://github.com/Homebrew/brew/tree/master/share/doc/homebrew> Homebrew Docs: <https://github.com/Homebrew/brew/tree/master/docs>

View File

@ -350,7 +350,7 @@ If you have already forked Homebrew on GitHub, then you can manually push (just
git push https://github.com/myname/homebrew-core/ <what-you-called-your-branch> git push https://github.com/myname/homebrew-core/ <what-you-called-your-branch>
``` ```
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. Now, please [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) for your changes.
* One formula per commit; one commit per formula * One formula per commit; one commit per formula
* Keep merge commits out of the pull request * Keep merge commits out of the pull request

View File

@ -25,8 +25,8 @@ A few requests:
- still create your branches on your fork rather than in the main repository - 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 - if still in doubt please ask for help and we'll help you out - these are
probably worth a read: probably worth a read:
- https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Brew-Test-Bot-For-Core-Contributors.md - https://github.com/Homebrew/brew/blob/master/docs/Brew-Test-Bot-For-Core-Contributors.md
- https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Maintainer-Guidelines.md - https://github.com/Homebrew/brew/blob/master/docs/Maintainer-Guidelines.md
- possibly everything else in the documentation - possibly everything else in the documentation
How does that sound? How does that sound?

View File

@ -82,7 +82,7 @@ In your formula's `install` method, do any installation steps which need to be d
system "npm", "install", *Language::Node.local_npm_install_args system "npm", "install", *Language::Node.local_npm_install_args
``` ```
This will install all of your Node modules dependencies to your local build path. You can now continue with your build steps and take care of the installation into the Homebrew `prefix` by your own, following the [general Homebrew formula instructions](https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md). This will install all of your Node modules dependencies to your local build path. You can now continue with your build steps and take care of the installation into the Homebrew `prefix` by your own, following the [general Homebrew formula instructions](https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md).
# Example # Example

View File

@ -1,6 +1,6 @@
# Prose Style Guidelines # Prose Style Guidelines
This is a set of style and usage guidelines for Homebrew's prose documentation aimed at users, contributors, and maintainers (as opposed to executable computer code). It applies to documents like those in `share/doc/homebrew` in the `Homebrew/brew` repo, announcement emails, and other communications with the Homebrew community. This is a set of style and usage guidelines for Homebrew's prose documentation aimed at users, contributors, and maintainers (as opposed to executable computer code). It applies to documents like those in `docs` in the `Homebrew/brew` repo, announcement emails, and other communications with the Homebrew community.
This does not apply to any Ruby or other computer code. You can use it to inform technical documentation extracted from computer code, like embedded man pages, but it's just a suggestion there. This does not apply to any Ruby or other computer code. You can use it to inform technical documentation extracted from computer code, like embedded man pages, but it's just a suggestion there.

View File

@ -6,7 +6,7 @@ The preferred and supported method of installing specific versions of
formulae is to use the formulae is to use the
[homebrew/versions](https://github.com/Homebrew/homebrew-versions) [homebrew/versions](https://github.com/Homebrew/homebrew-versions)
tap. If the version youre looking for isnt available, consider [opening a tap. If the version youre looking for isnt available, consider [opening 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)! 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 ### Installing directly from pull-requests

View File

@ -151,7 +151,7 @@ for <var>version</var> is <code>v1</code>.</p>
information on all installed formulae.</p> information on all installed formulae.</p>
<p>See the docs for examples of using the JSON: <p>See the docs for examples of using the JSON:
<a href="https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md</a></p></dd> <a href="https://github.com/Homebrew/brew/blob/master/docs/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/docs/Querying-Brew.md</a></p></dd>
<dt><code>install</code> [<code>--debug</code>] [<code>--env=</code><var>std</var>|<var>super</var>] [<code>--ignore-dependencies</code>] [<code>--only-dependencies</code>] [<code>--cc=</code><var>compiler</var>] [<code>--build-from-source</code>] [<code>--devel</code>|<code>--HEAD</code>] [<code>--keep-tmp</code>] <var>formula</var></dt><dd><p>Install <var>formula</var>.</p> <dt><code>install</code> [<code>--debug</code>] [<code>--env=</code><var>std</var>|<var>super</var>] [<code>--ignore-dependencies</code>] [<code>--only-dependencies</code>] [<code>--cc=</code><var>compiler</var>] [<code>--build-from-source</code>] [<code>--devel</code>|<code>--HEAD</code>] [<code>--keep-tmp</code>] <var>formula</var></dt><dd><p>Install <var>formula</var>.</p>
<p><var>formula</var> is usually the name of the formula to install, but it can be specified <p><var>formula</var> is usually the name of the formula to install, but it can be specified
@ -344,7 +344,7 @@ for <var>version</var> is <code>v1</code>.</p>
<p>Pass <code>--installed</code> to get information on installed taps.</p> <p>Pass <code>--installed</code> to get information on installed taps.</p>
<p>See the docs for examples of using the JSON: <p>See the docs for examples of using the JSON:
<a href="https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Querying-Brew.md</a></p></dd> <a href="https://github.com/Homebrew/brew/blob/master/docs/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/docs/Querying-Brew.md</a></p></dd>
<dt><code>tap-pin</code> <var>tap</var></dt><dd><p>Pin <var>tap</var>, prioritizing its formulae over core when formula names are supplied <dt><code>tap-pin</code> <var>tap</var></dt><dd><p>Pin <var>tap</var>, prioritizing its formulae over core when formula names are supplied
by the user. See also <code>tap-unpin</code>.</p></dd> by the user. See also <code>tap-unpin</code>.</p></dd>
<dt><code>tap-unpin</code> <var>tap</var></dt><dd><p>Unpin <var>tap</var> so its formulae are no longer prioritized. See also <code>tap-pin</code>.</p></dd> <dt><code>tap-unpin</code> <var>tap</var></dt><dd><p>Unpin <var>tap</var> so its formulae are no longer prioritized. See also <code>tap-pin</code>.</p></dd>
@ -590,7 +590,7 @@ scripts that reside somewhere in the <code>PATH</code>, named <code>brew-</code>
to create your own commands without modifying Homebrew's internals.</p> to create your own commands without modifying Homebrew's internals.</p>
<p>Instructions for creating your own commands can be found in the docs: <p>Instructions for creating your own commands can be found in the docs:
<a href="https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/External-Commands.md</a></p> <a href="https://github.com/Homebrew/brew/blob/master/docs/External-Commands.md" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/docs/External-Commands.md</a></p>
<h2 id="SPECIFYING-FORMULAE">SPECIFYING FORMULAE</h2> <h2 id="SPECIFYING-FORMULAE">SPECIFYING FORMULAE</h2>
@ -669,7 +669,7 @@ Homebrew uses the GitHub API for features such as <code>brew search</code>.</p>
the number of parallel jobs to run when building with <code>make</code>(1).</p> the number of parallel jobs to run when building with <code>make</code>(1).</p>
<p><em>Default:</em> the number of available CPU cores.</p></dd> <p><em>Default:</em> the number of available CPU cores.</p></dd>
<dt><code>HOMEBREW_NO_ANALYTICS</code></dt><dd><p>If set, Homebrew will not send analytics. See: <a href="https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics</a></p></dd> <dt><code>HOMEBREW_NO_ANALYTICS</code></dt><dd><p>If set, Homebrew will not send analytics. See: <a href="https://github.com/Homebrew/brew/blob/master/docs/Analytics.md#analytics" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/docs/Analytics.md#analytics</a></p></dd>
<dt><code>HOMEBREW_NO_AUTO_UPDATE</code></dt><dd><p>If set, Homebrew will not auto-update before running <code>brew install</code>, <dt><code>HOMEBREW_NO_AUTO_UPDATE</code></dt><dd><p>If set, Homebrew will not auto-update before running <code>brew install</code>,
<code>brew upgrade</code> or <code>brew tap</code>.</p></dd> <code>brew upgrade</code> or <code>brew tap</code>.</p></dd>
<dt><code>HOMEBREW_NO_EMOJI</code></dt><dd><p>If set, Homebrew will not print the <code>HOMEBREW_INSTALL_BADGE</code> on a <dt><code>HOMEBREW_NO_EMOJI</code></dt><dd><p>If set, Homebrew will not print the <code>HOMEBREW_INSTALL_BADGE</code> on a
@ -721,7 +721,7 @@ your shell profile, or you can use it before a brew command:</p>
<h2 id="SEE-ALSO">SEE ALSO</h2> <h2 id="SEE-ALSO">SEE ALSO</h2>
<p>Homebrew Documentation: <a href="https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/</a></p> <p>Homebrew Documentation: <a href="https://github.com/Homebrew/brew/blob/master/docs/" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/docs/</a></p>
<p><code>git</code>(1), <code>git-log</code>(1)</p> <p><code>git</code>(1), <code>git-log</code>(1)</p>

View File

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

View File

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

@ -213,7 +213,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\. Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\.
. .
.IP .IP
See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/brew/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/docs/Querying\-Brew\.md\fR
. .
.TP .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\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] \fIformula\fR \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\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] \fIformula\fR
@ -473,7 +473,7 @@ Print a JSON representation of \fItaps\fR\. Currently the only accepted value fo
Pass \fB\-\-installed\fR to get information on installed taps\. Pass \fB\-\-installed\fR to get information on installed taps\.
. .
.IP .IP
See the docs for examples of using the JSON: \fIhttps://github\.com/Homebrew/brew/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/docs/Querying\-Brew\.md\fR
. .
.TP .TP
\fBtap\-pin\fR \fItap\fR \fBtap\-pin\fR \fItap\fR
@ -790,7 +790,7 @@ If \fB\-\-keep\-tmp\fR is passed, retain the temporary directory containing the
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\. 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 .P
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 Instructions for creating your own commands can be found in the docs: \fIhttps://github\.com/Homebrew/brew/blob/master/docs/External\-Commands\.md\fR
. .
.SH "SPECIFYING FORMULAE" .SH "SPECIFYING FORMULAE"
Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms: Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms:
@ -909,7 +909,7 @@ If set, instructs Homebrew to use the value of \fBHOMEBREW_MAKE_JOBS\fR as the n
. .
.TP .TP
\fBHOMEBREW_NO_ANALYTICS\fR \fBHOMEBREW_NO_ANALYTICS\fR
If set, Homebrew will not send analytics\. See: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics\.md#analytics\fR If set, Homebrew will not send analytics\. See: \fIhttps://github\.com/Homebrew/brew/blob/master/docs/Analytics\.md#analytics\fR
. .
.TP .TP
\fBHOMEBREW_NO_AUTO_UPDATE\fR \fBHOMEBREW_NO_AUTO_UPDATE\fR
@ -989,7 +989,7 @@ http_proxy=http://<user>:<password>@<host>:<port> brew install foo
.IP "" 0 .IP "" 0
. .
.SH "SEE ALSO" .SH "SEE ALSO"
Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/\fR Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/docs/\fR
. .
.P .P
\fBgit\fR(1), \fBgit\-log\fR(1) \fBgit\fR(1), \fBgit\-log\fR(1)
@ -1013,4 +1013,3 @@ Homebrew/brew \fIhttps://github\.com/Homebrew/brew/issues\fR
Homebrew/homebrew\-core \fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR Homebrew/homebrew\-core \fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR
. .
.IP "" 0 .IP "" 0