mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use more docs.brew.sh short links

Browse Source 
These are nicer on the eyes.
This commit is contained in:
Mike McQuaid 2018-02-22 19:46:58 +00:00
parent 35efc5ab23
commit f2ce6489b2
15 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.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://docs.brew.sh/Troubleshooting.html). * Read [the Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting).
* Open an issue on the formula's repository or on Homebrew/brew if it's not a formula-specific issue. * Open an issue on the formula's repository or on Homebrew/brew if it's not a formula-specific issue.
### Propose a feature ### Propose a feature

2
Library/Homebrew/README.md
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://docs.brew.sh/Formula-Cookbook.html) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae. You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae.
Good luck! Good luck!

2
Library/Homebrew/cmd/analytics.rb
View File

@ -1,6 +1,6 @@
#: * `analytics` [`state`]: #: * `analytics` [`state`]:
#: Display anonymous user behaviour analytics state. #: Display anonymous user behaviour analytics state.
#: Read more at <https://docs.brew.sh/Analytics.html>. #: Read more at <https://docs.brew.sh/Analytics>.
#: #:
#: * `analytics` (`on`|`off`): #: * `analytics` (`on`|`off`):
#: Turn on/off Homebrew's analytics. #: Turn on/off Homebrew's analytics.

2
Library/Homebrew/cmd/help.rb
View File

@ -16,7 +16,7 @@ HOMEBREW_HELP = <<~EOS.freeze
Developers: Developers:
brew create [URL [--no-fetch]] brew create [URL [--no-fetch]]
brew edit [FORMULA...] brew edit [FORMULA...]
https://docs.brew.sh/Formula-Cookbook.html https://docs.brew.sh/Formula-Cookbook
Further help: Further help:
man brew man brew

2
Library/Homebrew/cmd/info.rb
View File

@ -17,7 +17,7 @@
#: information on all installed formulae. #: information on all installed formulae.
#: #:
#: See the docs for examples of using the JSON output: #: See the docs for examples of using the JSON output:
#: <https://docs.brew.sh/Querying-Brew.html> #: <https://docs.brew.sh/Querying-Brew>
require "missing_formula" require "missing_formula"
require "caveats" require "caveats"

2
Library/Homebrew/cmd/tap-info.rb
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 output: #: See the docs for examples of using the JSON output:
#: <https://docs.brew.sh/Querying-Brew.html> #: <https://docs.brew.sh/Querying-Brew>
require "tap" require "tap"

2
Library/Homebrew/cmd/update-report.rb
View File

@ -35,7 +35,7 @@ module Homebrew
ohai "Homebrew has enabled anonymous aggregate user behaviour analytics." ohai "Homebrew has enabled anonymous aggregate user behaviour analytics."
puts <<~EOS puts <<~EOS
#{Tty.bold}Read the analytics documentation (and how to opt-out) here: #{Tty.bold}Read the analytics documentation (and how to opt-out) here:
#{Formatter.url("https://docs.brew.sh/Analytics.html")}#{Tty.reset} #{Formatter.url("https://docs.brew.sh/Analytics")}#{Tty.reset}
EOS EOS

2
Library/Homebrew/dev-cmd/create.rb
View File

@ -167,7 +167,7 @@ class FormulaCreator
def template def template
<<~EOS <<~EOS
# Documentation: https://docs.brew.sh/Formula-Cookbook.html # Documentation: https://docs.brew.sh/Formula-Cookbook
# 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!
class #{Formulary.class_s(name)} < Formula class #{Formulary.class_s(name)} < Formula

4
Library/Homebrew/formula.rb
View File

@ -28,7 +28,7 @@ require "language/python"
# @see SharedEnvExtension # @see SharedEnvExtension
# @see FileUtils # @see FileUtils
# @see Pathname # @see Pathname
# @see https://docs.brew.sh/Formula-Cookbook.html Formula Cookbook # @see https://docs.brew.sh/Formula-Cookbook 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
@ -2057,7 +2057,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://docs.brew.sh/Bottles.html # https://docs.brew.sh/Bottles
# You can ignore this block entirely if submitting to Homebrew/homebrew-core. # You can ignore this block entirely if submitting to Homebrew/homebrew-core.
# It'll be handled for you by the Brew Test Bot. # It'll be handled for you by the Brew Test Bot.
# #

4
Library/Homebrew/manpages/brew.1.md.erb
View File

@ -76,7 +76,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://docs.brew.sh/External-Commands.html> <https://docs.brew.sh/External-Commands>
## SPECIFYING FORMULAE ## SPECIFYING FORMULAE
@ -193,7 +193,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://docs.brew.sh/Analytics.html> If set, Homebrew will not send analytics. See: <https://docs.brew.sh/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`,

2
Library/Homebrew/missing_formula.rb
View File

@ -155,7 +155,7 @@ module Homebrew
git -C "$(brew --repo #{tap})" show #{short_hash}^:#{relative_path} git -C "$(brew --repo #{tap})" show #{short_hash}^:#{relative_path}
If you still use this formula consider creating your own tap: If you still use this formula consider creating your own tap:
https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap.html https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap
EOS EOS
end end
end end

2
Library/Homebrew/os.rb
View File

@ -17,7 +17,7 @@ module OS
require "os/mac" require "os/mac"
# Don't tell people to report issues on unsupported versions of macOS. # Don't tell people to report issues on unsupported versions of macOS.
if !OS::Mac.prerelease? && !OS::Mac.outdated_release? if !OS::Mac.prerelease? && !OS::Mac.outdated_release?
ISSUES_URL = "https://docs.brew.sh/Troubleshooting.html".freeze ISSUES_URL = "https://docs.brew.sh/Troubleshooting".freeze
end end
PATH_OPEN = "/usr/bin/open".freeze PATH_OPEN = "/usr/bin/open".freeze
elsif OS.linux? elsif OS.linux?

2
Library/Homebrew/utils/analytics.rb
View File

@ -40,7 +40,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://docs.brew.sh/Analytics.html # https://docs.brew.sh/Analytics
# 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"]

4
README.md
View File

@ -14,7 +14,7 @@ Features, usage and installation instructions are [summarised on the homepage](h
## Troubleshooting ## Troubleshooting
First, please run `brew update` and `brew doctor`. First, please run `brew update` and `brew doctor`.
Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting.html). Second, read the [Troubleshooting Checklist](https://docs.brew.sh/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.**
@ -26,7 +26,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 --strict` with some of the packages you use (e.g. `brew audit --strict wget` if you use `wget`) and then read through the warnings, try to fix them until `brew audit --strict` shows no results and [submit a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html). If no formulae you use have warnings you can run `brew audit --strict` without arguments to have it run on all packages and pick one. A good starting point for contributing is running `brew audit --strict` with some of the packages you use (e.g. `brew audit --strict wget` if you use `wget`) and then read through the warnings, try to fix them until `brew audit --strict` shows no results and [submit a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request). If no formulae you use have warnings you can run `brew audit --strict` without arguments to have it run on all packages and pick one.
Alternatively, for something more substantial, check out one of the issues labeled `help wanted` in [Homebrew/brew](https://github.com/homebrew/brew/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or [Homebrew/homebrew-core](https://github.com/homebrew/homebrew-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). Alternatively, for something more substantial, check out one of the issues labeled `help wanted` in [Homebrew/brew](https://github.com/homebrew/brew/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or [Homebrew/homebrew-core](https://github.com/homebrew/homebrew-core/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).

10
manpages/brew.1
View File

@ -45,7 +45,7 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su
. .
.TP .TP
\fBanalytics\fR [\fBstate\fR] \fBanalytics\fR [\fBstate\fR]
Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\.html\fR\. Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
. .
.TP .TP
\fBanalytics\fR (\fBon\fR|\fBoff\fR) \fBanalytics\fR (\fBon\fR|\fBoff\fR)
@ -226,7 +226,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 output: \fIhttps://docs\.brew\.sh/Querying\-Brew\.html\fR See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
. .
.TP .TP
\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] [\fB\-\-force\fR] [\fB\-\-verbose\fR] \fIformula\fR [\fIoptions\fR \.\.\.] \fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] [\fB\-\-force\fR] [\fB\-\-verbose\fR] \fIformula\fR [\fIoptions\fR \.\.\.]
@ -510,7 +510,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 output: \fIhttps://docs\.brew\.sh/Querying\-Brew\.html\fR See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
. .
.TP .TP
\fBtap\-pin\fR \fItap\fR \fBtap\-pin\fR \fItap\fR
@ -937,7 +937,7 @@ Integrates Homebrew formulae with macOS\'s \fBlaunchctl\fR(1) manager: \fIhttps:
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://docs\.brew\.sh/External\-Commands\.html\fR Instructions for creating your own commands can be found in the docs: \fIhttps://docs\.brew\.sh/External\-Commands\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:
@ -1052,7 +1052,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://docs\.brew\.sh/Analytics\.html\fR If set, Homebrew will not send analytics\. See: \fIhttps://docs\.brew\.sh/Analytics\fR
. .
.TP .TP
\fBHOMEBREW_NO_AUTO_UPDATE\fR \fBHOMEBREW_NO_AUTO_UPDATE\fR