Use https for all docs.brew.sh links.

May as well use the more secure link when possible.
This commit is contained in:
Mike McQuaid 2017-07-27 15:59:37 +01:00
parent 97b757bc96
commit baa61f5a6e
21 changed files with 38 additions and 38 deletions

View File

@ -5,7 +5,7 @@ First time contributing to Homebrew? Read our [Code of Conduct](https://github.c
* run `brew update` (twice)
* run and read `brew doctor`
* read [the Troubleshooting Checklist](http://docs.brew.sh/Troubleshooting.html)
* read [the Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting.html)
* open an issue on the formula's repository or on Homebrew/brew if it's not a formula-specific issue
### 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.
You may also find the [Formula Cookbook](http://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.html) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae.
Good luck!

View File

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

View File

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

View File

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

View File

@ -13,7 +13,7 @@
#: Pass `--installed` to get information on installed taps.
#:
#: See the docs for examples of using the JSON output:
#: <http://docs.brew.sh/Querying-Brew.html>
#: <https://docs.brew.sh/Querying-Brew.html>
require "tap"

View File

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

View File

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

View File

@ -39,7 +39,7 @@ module Homebrew
```
## Documentation
`brew help`, `man brew` or check [Homebrew's documentation](https://github.com/Homebrew/brew/tree/master/docs#readme).
`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).
EOS
write_path(tap, "README.md", readme)

View File

@ -27,7 +27,7 @@ require "extend/ENV"
# @see SharedEnvExtension
# @see FileUtils
# @see Pathname
# @see http://docs.brew.sh/Formula-Cookbook.html Formula Cookbook
# @see https://docs.brew.sh/Formula-Cookbook.html Formula Cookbook
# @see https://github.com/styleguide/ruby Ruby Style Guide
#
# <pre>class Wget < Formula
@ -2069,7 +2069,7 @@ class 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.
# http://docs.brew.sh/Bottles.html
# https://docs.brew.sh/Bottles.html
# You can ignore this block entirely if submitting to Homebrew/Homebrew, It'll be
# handled for you by the Brew Test Bot.
#

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.
Instructions for creating your own commands can be found in the docs:
<http://docs.brew.sh/External-Commands.html>
<https://docs.brew.sh/External-Commands.html>
## SPECIFYING FORMULAE
@ -189,7 +189,7 @@ can take several different forms:
*Default:* the number of available CPU cores.
* `HOMEBREW_NO_ANALYTICS`:
If set, Homebrew will not send analytics. See: <http://docs.brew.sh/Analytics.html>
If set, Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics.html>
* `HOMEBREW_NO_AUTO_UPDATE`:
If set, Homebrew will not auto-update before running `brew install`,
@ -252,7 +252,7 @@ If your proxy requires authentication:
## SEE ALSO
Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/docs/>
Homebrew Documentation: <https://docs.brew.sh>
`brew-cask`(1), `git`(1), `git-log`(1)

View File

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

View File

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

View File

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

View File

@ -9,12 +9,12 @@ Features, usage and installation instructions are [summarised on the homepage](h
3. Or use `brew search --desc <keyword>` to browse packages from the command line.
## More Documentation
`brew help`, `man brew` or check [our documentation](http://docs.brew.sh/).
`brew help`, `man brew` or check [our documentation](https://docs.brew.sh/).
## Troubleshooting
First, please run `brew update` and `brew doctor`.
Second, read the [Troubleshooting Checklist](http://docs.brew.sh/Troubleshooting.html).
Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshooting.html).
**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.
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](http://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. Good luck!
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. Good luck!
## Security
Please report security issues to our [HackerOne](https://hackerone.com/homebrew/).

View File

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

View File

@ -358,7 +358,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>
```
Now, [open a pull request](http://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html) for your changes.
Now, [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html) for your changes.
* One formula per commit; one commit per formula
* Keep merge commits out of the pull request

View File

@ -39,7 +39,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `analytics` [`state`]:
Display anonymous user behaviour analytics state.
Read more at <http://docs.brew.sh/Analytics.html>.
Read more at <https://docs.brew.sh/Analytics.html>.
* `analytics` (`on`|`off`):
Turn on/off Homebrew's analytics.
@ -196,7 +196,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
information on all installed formulae.
See the docs for examples of using the JSON output:
<http://docs.brew.sh/Querying-Brew.html>
<https://docs.brew.sh/Querying-Brew.html>
* `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [`options` ...]:
Install `formula`.
@ -475,7 +475,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
Pass `--installed` to get information on installed taps.
See the docs for examples of using the JSON output:
<http://docs.brew.sh/Querying-Brew.html>
<https://docs.brew.sh/Querying-Brew.html>
* `tap-pin` `tap`:
Pin `tap`, prioritizing its formulae over core when formula names are supplied
@ -888,7 +888,7 @@ scripts that reside somewhere in the `PATH`, named `brew-``cmdname` or
to create your own commands without modifying Homebrew's internals.
Instructions for creating your own commands can be found in the docs:
<http://docs.brew.sh/External-Commands.html>
<https://docs.brew.sh/External-Commands.html>
## SPECIFYING FORMULAE
@ -1001,7 +1001,7 @@ can take several different forms:
*Default:* the number of available CPU cores.
* `HOMEBREW_NO_ANALYTICS`:
If set, Homebrew will not send analytics. See: <http://docs.brew.sh/Analytics.html>
If set, Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics.html>
* `HOMEBREW_NO_AUTO_UPDATE`:
If set, Homebrew will not auto-update before running `brew install`,
@ -1064,7 +1064,7 @@ If your proxy requires authentication:
## SEE ALSO
Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/docs/>
Homebrew Documentation: <https://docs.brew.sh>
`brew-cask`(1), `git`(1), `git-log`(1)

View File

@ -34,9 +34,9 @@ A few requests:
own fork.
- if still in doubt please ask for help and we'll help you out
- please read:
- http://docs.brew.sh/Brew-Test-Bot-For-Core-Contributors.html
- http://docs.brew.sh/Maintainer-Guidelines.html
- possibly everything else on http://docs.brew.sh
- https://docs.brew.sh/Brew-Test-Bot-For-Core-Contributors.html
- https://docs.brew.sh/Maintainer-Guidelines.html
- possibly everything else on https://docs.brew.sh
How does that sound?

View File

@ -115,7 +115,7 @@ end
<div class="group row">
<h2 id="further-doc">{{ page.pagecontent.doc.further }}</h2>
<div class="button">
<p><a href="http://docs.brew.sh/">docs.brew.sh</a></p>
<p><a href="https://docs.brew.sh/">docs.brew.sh</a></p>
</div>
</div>
</li>

View File

@ -45,7 +45,7 @@ Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is su
.
.TP
\fBanalytics\fR [\fBstate\fR]
Display anonymous user behaviour analytics state\. Read more at \fIhttp://docs\.brew\.sh/Analytics\.html\fR\.
Display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\.html\fR\.
.
.TP
\fBanalytics\fR (\fBon\fR|\fBoff\fR)
@ -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\.
.
.IP
See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR
See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\.html\fR
.
.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] \fIformula\fR [\fIoptions\fR \.\.\.]
@ -494,7 +494,7 @@ Print a JSON representation of \fItaps\fR\. Currently the only accepted value fo
Pass \fB\-\-installed\fR to get information on installed taps\.
.
.IP
See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR
See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\.html\fR
.
.TP
\fBtap\-pin\fR \fItap\fR
@ -921,7 +921,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\.
.
.P
Instructions for creating your own commands can be found in the docs: \fIhttp://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\.html\fR
.
.SH "SPECIFYING FORMULAE"
Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms:
@ -1032,7 +1032,7 @@ If set, instructs Homebrew to use the value of \fBHOMEBREW_MAKE_JOBS\fR as the n
.
.TP
\fBHOMEBREW_NO_ANALYTICS\fR
If set, Homebrew will not send analytics\. See: \fIhttp://docs\.brew\.sh/Analytics\.html\fR
If set, Homebrew will not send analytics\. See: \fIhttps://docs\.brew\.sh/Analytics\.html\fR
.
.TP
\fBHOMEBREW_NO_AUTO_UPDATE\fR
@ -1108,7 +1108,7 @@ http_proxy=http://<user>:<password>@<host>:<port> brew install foo
.IP "" 0
.
.SH "SEE ALSO"
Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/docs/\fR
Homebrew Documentation: \fIhttps://docs\.brew\.sh\fR
.
.P
\fBbrew\-cask\fR(1), \fBgit\fR(1), \fBgit\-log\fR(1)