From b85ee1cb8ffef36503f46685609442f79660737a Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Mon, 19 Sep 2016 20:20:08 +0100 Subject: Update documentation links. --- docs/Common-Issues.md | 2 +- docs/External-Commands.md | 2 +- docs/Formula-Cookbook.md | 2 +- docs/New-Maintainer-Checklist.md | 4 ++-- docs/Node-for-Formula-Authors.md | 2 +- docs/Prose-Style-Guidelines.md | 2 +- docs/Tips-N'-Tricks.md | 2 +- docs/brew.1.html | 10 +++++----- 8 files changed, 13 insertions(+), 13 deletions(-) (limited to 'docs') diff --git a/docs/Common-Issues.md b/docs/Common-Issues.md index 320ad6d89..14f2836c4 100644 --- a/docs/Common-Issues.md +++ b/docs/Common-Issues.md @@ -76,7 +76,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/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:425:in `factory' /usr/local/Library/Contributions/examples/brew-upgrade.rb:7 diff --git a/docs/External-Commands.md b/docs/External-Commands.md index 090b664cb..8fe6932b0 100644 --- a/docs/External-Commands.md +++ b/docs/External-Commands.md @@ -81,4 +81,4 @@ These commands have been contributed by Homebrew users but are not included in t > ``` ## SEE ALSO -Homebrew Docs: +Homebrew Docs: diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 876a6645f..40c672a65 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -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/ ``` -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 * Keep merge commits out of the pull request diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index c59e1c341..2bdff0202 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -25,8 +25,8 @@ A few requests: - 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 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/share/doc/homebrew/Maintainer-Guidelines.md + - https://github.com/Homebrew/brew/blob/master/docs/Brew-Test-Bot-For-Core-Contributors.md + - https://github.com/Homebrew/brew/blob/master/docs/Maintainer-Guidelines.md - possibly everything else in the documentation How does that sound? diff --git a/docs/Node-for-Formula-Authors.md b/docs/Node-for-Formula-Authors.md index 642a0f067..c78668a58 100644 --- a/docs/Node-for-Formula-Authors.md +++ b/docs/Node-for-Formula-Authors.md @@ -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 ``` -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 diff --git a/docs/Prose-Style-Guidelines.md b/docs/Prose-Style-Guidelines.md index 8c4f1d1f0..1d8e2b0fc 100644 --- a/docs/Prose-Style-Guidelines.md +++ b/docs/Prose-Style-Guidelines.md @@ -1,6 +1,6 @@ # 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. diff --git a/docs/Tips-N'-Tricks.md b/docs/Tips-N'-Tricks.md index e97f740ed..d3ed83fd2 100644 --- a/docs/Tips-N'-Tricks.md +++ b/docs/Tips-N'-Tricks.md @@ -6,7 +6,7 @@ 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 -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 diff --git a/docs/brew.1.html b/docs/brew.1.html index 7e1e04e94..b6c4be718 100644 --- a/docs/brew.1.html +++ b/docs/brew.1.html @@ -151,7 +151,7 @@ for version is v1.

information on all installed formulae.

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

install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source] [--devel|--HEAD] [--keep-tmp] formula

Install formula.

formula is usually the name of the formula to install, but it can be specified @@ -344,7 +344,7 @@ for version is v1.

Pass --installed to get information on installed taps.

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

tap-pin tap

Pin tap, prioritizing its formulae over core when formula names are supplied by the user. See also tap-unpin.

tap-unpin tap

Unpin tap so its formulae are no longer prioritized. See also tap-pin.

@@ -590,7 +590,7 @@ scripts that reside somewhere in the PATH, named brew- to create your own commands without modifying Homebrew's internals.

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

@@ -669,7 +669,7 @@ Homebrew uses the GitHub API for features such as brew search.

the number of parallel jobs to run when building with make(1).

Default: the number of available CPU cores.

-
HOMEBREW_NO_ANALYTICS

If set, Homebrew will not send analytics. See: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics

+
HOMEBREW_NO_ANALYTICS

If set, Homebrew will not send analytics. See: https://github.com/Homebrew/brew/blob/master/docs/Analytics.md#analytics

HOMEBREW_NO_AUTO_UPDATE

If set, Homebrew will not auto-update before running brew install, brew upgrade or brew tap.

HOMEBREW_NO_EMOJI

If set, Homebrew will not print the HOMEBREW_INSTALL_BADGE on a @@ -721,7 +721,7 @@ your shell profile, or you can use it before a brew command:

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)

-- cgit v1.2.3