From 9a6cd9b83fc8596727df0157e89faee302907cda Mon Sep 17 00:00:00 2001 From: Jonathan Chang <jchang641@gmail.com> Date: Wed, 4 Jan 2017 16:16:00 -0600 Subject: [PATCH] docs: fix titles on docs.brew.sh --- docs/Acceptable-Formulae.md | 1 + docs/Analytics.md | 1 + docs/Bottles.md | 1 + docs/Brew-Test-Bot-For-Core-Contributors.md | 1 + docs/Brew-Test-Bot.md | 1 + docs/C++-Standard-Libraries.md | 1 + docs/Checksum_Deprecation.md | 1 + docs/Common-Issues.md | 1 + docs/Custom-GCC-and-cross-compilers.md | 1 + docs/External-Commands.md | 1 + docs/Formula-Cookbook.md | 1 + docs/Gems,-Eggs-and-Perl-Modules.md | 1 + docs/Homebrew-and-Python.md | 1 + docs/How-to-Create-and-Maintain-a-Tap.md | 1 + docs/Installation.md | 1 + docs/Interesting-Taps-&-Forks.md | 1 + docs/Kickstarter-Supporters.md | 1 + docs/Maintainer-Guidelines.md | 1 + docs/Maintainers-Avoiding-Burnout.md | 1 + docs/Migrating-A-Formula-To-A-Tap.md | 1 + docs/New-Maintainer-Checklist.md | 1 + docs/Querying-Brew.md | 1 + docs/Versions.md | 1 + docs/brew-tap.md | 1 + 24 files changed, 24 insertions(+) diff --git a/docs/Acceptable-Formulae.md b/docs/Acceptable-Formulae.md index 12084fad76..9f4fb45dba 100644 --- a/docs/Acceptable-Formulae.md +++ b/docs/Acceptable-Formulae.md @@ -1,4 +1,5 @@ # Acceptable Formulae + Some formulae should not go in [homebrew/core](https://github.com/Homebrew/homebrew-core). But there are additional [Interesting Taps & Forks](Interesting-Taps-&-Forks.md) and anyone can start their diff --git a/docs/Analytics.md b/docs/Analytics.md index 80515d0799..b4e73f75df 100644 --- a/docs/Analytics.md +++ b/docs/Analytics.md @@ -1,4 +1,5 @@ # Anonymous Aggregate User Behaviour Analytics + Homebrew has begun gathering anonymous aggregate user behaviour analytics and reporting these to Google Analytics. You will be notified the first time you run `brew update` or install Homebrew. ## Why? diff --git a/docs/Bottles.md b/docs/Bottles.md index 7d2982c142..2752ebe032 100644 --- a/docs/Bottles.md +++ b/docs/Bottles.md @@ -1,4 +1,5 @@ # Bottles (binary packages) + Bottles are produced by installing a formula with `brew install --build-bottle $FORMULA` and then bottling it with `brew bottle $FORMULA`. This outputs the bottle DSL which should be inserted into the formula file. ## Usage diff --git a/docs/Brew-Test-Bot-For-Core-Contributors.md b/docs/Brew-Test-Bot-For-Core-Contributors.md index 4b697066c4..f4c9a0ec6e 100644 --- a/docs/Brew-Test-Bot-For-Core-Contributors.md +++ b/docs/Brew-Test-Bot-For-Core-Contributors.md @@ -1,4 +1,5 @@ # Brew Test Bot For Core Contributors + If a build has run and passed on `brew test-bot` then it can be used to quickly bottle formulae. There are two types of Jenkins jobs you will interact with: diff --git a/docs/Brew-Test-Bot.md b/docs/Brew-Test-Bot.md index 0a5f76bda9..db39327fac 100644 --- a/docs/Brew-Test-Bot.md +++ b/docs/Brew-Test-Bot.md @@ -1,4 +1,5 @@ # Brew Test Bot + `brew test-bot` is the name for the automated review and testing system funded by [our Kickstarter in 2013](https://www.kickstarter.com/projects/homebrew/brew-test-bot). diff --git a/docs/C++-Standard-Libraries.md b/docs/C++-Standard-Libraries.md index 0bb987def7..c1725f2020 100644 --- a/docs/C++-Standard-Libraries.md +++ b/docs/C++-Standard-Libraries.md @@ -1,4 +1,5 @@ # C++ Standard Libraries + There are two C++ standard libraries supported by Apple compilers. The default for 10.8 and earlier is **libstdc++**, supported by Apple GCC diff --git a/docs/Checksum_Deprecation.md b/docs/Checksum_Deprecation.md index c86f3a1a36..3ef0d41ecf 100644 --- a/docs/Checksum_Deprecation.md +++ b/docs/Checksum_Deprecation.md @@ -1,4 +1,5 @@ # MD5 and SHA-1 Deprecation + During early 2015 Homebrew started the process of deprecating _SHA1_ for package integrity verification. Since then every formulae under the Homebrew organisation has been moved onto _SHA256_ verification; this includes both source packages diff --git a/docs/Common-Issues.md b/docs/Common-Issues.md index 14f2836c41..8da622ab42 100644 --- a/docs/Common-Issues.md +++ b/docs/Common-Issues.md @@ -1,4 +1,5 @@ # Common Issues + This is a list of commonly encountered problems, known issues, and their solutions. ### `brew` complains about absence of "Command Line Tools" diff --git a/docs/Custom-GCC-and-cross-compilers.md b/docs/Custom-GCC-and-cross-compilers.md index 99b52c060b..08a8b2b194 100644 --- a/docs/Custom-GCC-and-cross-compilers.md +++ b/docs/Custom-GCC-and-cross-compilers.md @@ -1,4 +1,5 @@ # Custom GCC and Cross Compilers + Homebrew depends on having an up-to-date version of Xcode because it comes with specific versions of build tools e.g. `clang`. diff --git a/docs/External-Commands.md b/docs/External-Commands.md index b88ba3fa56..59622bd3ab 100644 --- a/docs/External-Commands.md +++ b/docs/External-Commands.md @@ -1,4 +1,5 @@ # External Commands + Homebrew, like Git, supports *external commands*. This lets you create new commands that can be run like: ```shell diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 69a47b2111..9d02a0f9a6 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -1,4 +1,5 @@ # Formula Cookbook + A formula is a package definition written in Ruby. It can be created with `brew create $URL`, installed with `brew install $FORMULA`, and debugged with `brew install --debug --verbose $FORMULA`. Formulae use the [Formula API](http://www.rubydoc.info/github/Homebrew/brew/master/Formula) which provides various Homebrew-specific helpers. ## Homebrew Terminology diff --git a/docs/Gems,-Eggs-and-Perl-Modules.md b/docs/Gems,-Eggs-and-Perl-Modules.md index dfbdc224f0..770d770f62 100644 --- a/docs/Gems,-Eggs-and-Perl-Modules.md +++ b/docs/Gems,-Eggs-and-Perl-Modules.md @@ -1,4 +1,5 @@ # Gems, Eggs and Perl Modules + On a fresh macOS installation there are three empty directories for add-ons available to all users: diff --git a/docs/Homebrew-and-Python.md b/docs/Homebrew-and-Python.md index 0757b5d244..e2f59c322e 100644 --- a/docs/Homebrew-and-Python.md +++ b/docs/Homebrew-and-Python.md @@ -1,4 +1,5 @@ # Python + This page describes how Python is handled in Homebrew for users. See [Python for Formula Authors](Python-for-Formula-Authors.md) for advice on writing formulae to install packages written in Python. Homebrew should work with any [CPython](https://stackoverflow.com/questions/2324208/is-there-any-difference-between-cpython-and-python) and defaults to the macOS system Python. diff --git a/docs/How-to-Create-and-Maintain-a-Tap.md b/docs/How-to-Create-and-Maintain-a-Tap.md index ff7de80299..5c8f3a8c42 100644 --- a/docs/How-to-Create-and-Maintain-a-Tap.md +++ b/docs/How-to-Create-and-Maintain-a-Tap.md @@ -1,4 +1,5 @@ # How to Create and Maintain a Tap + Taps are external sources of Homebrew formulae and/or external commands. They can be created by anyone to provide their own formulae and/or external commands to any Homebrew user. diff --git a/docs/Installation.md b/docs/Installation.md index ff5649a722..dbe8b9917a 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,4 +1,5 @@ # Installation + The suggested and easiest way to install Homebrew is on the [homepage](http://brew.sh). diff --git a/docs/Interesting-Taps-&-Forks.md b/docs/Interesting-Taps-&-Forks.md index dcb860a23c..a5c6094412 100644 --- a/docs/Interesting-Taps-&-Forks.md +++ b/docs/Interesting-Taps-&-Forks.md @@ -1,4 +1,5 @@ # Interesting Taps & Forks + A Tap is homebrew-speak for a git repository containing extra formulae. Homebrew has the capability to add (and remove) multiple taps to your local installation with the `brew tap` and `brew untap` command. Type `man brew` in your Terminal. The main repository https://github.com/Homebrew/homebrew-core, often called `homebrew/core`, is always built-in. diff --git a/docs/Kickstarter-Supporters.md b/docs/Kickstarter-Supporters.md index ae9556390f..3f39b435c0 100644 --- a/docs/Kickstarter-Supporters.md +++ b/docs/Kickstarter-Supporters.md @@ -1,4 +1,5 @@ # Kickstarter Supporters + This file contains a list of the awesome people who gave 拢5 or more to [our Kickstarter](https://www.kickstarter.com/projects/homebrew/brew-test-bot). diff --git a/docs/Maintainer-Guidelines.md b/docs/Maintainer-Guidelines.md index d83118642a..fdb7e88f9c 100644 --- a/docs/Maintainer-Guidelines.md +++ b/docs/Maintainer-Guidelines.md @@ -1,4 +1,5 @@ # Maintainer Guidelines + **This guide is for maintainers.** These special people have **write access** to Homebrew鈥檚 repository and help merge the contributions of others. You may find what is written here interesting, but it鈥檚 diff --git a/docs/Maintainers-Avoiding-Burnout.md b/docs/Maintainers-Avoiding-Burnout.md index f3ba3e346c..99353d946b 100644 --- a/docs/Maintainers-Avoiding-Burnout.md +++ b/docs/Maintainers-Avoiding-Burnout.md @@ -1,4 +1,5 @@ # Maintainers: Avoiding Burnout + **This guide is for maintainers.** These special people have **write access** to Homebrew鈥檚 repository and help merge the contributions of others. You may find what is written here interesting, but it鈥檚 diff --git a/docs/Migrating-A-Formula-To-A-Tap.md b/docs/Migrating-A-Formula-To-A-Tap.md index 7bc984f84a..ba55770563 100644 --- a/docs/Migrating-A-Formula-To-A-Tap.md +++ b/docs/Migrating-A-Formula-To-A-Tap.md @@ -1,4 +1,5 @@ # Migrating A Formula To A Tap + There are times when we may wish to migrate a formula from one tap into another tap. To do this: 1. Create a pull request to the new tap adding the formula file as-is from the original tap. Fix any test failures that may occur due to the stricter requirements for new formulae than existing formula (e.g. `brew audit --strict` must pass for that formula). diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index b1117ce9bc..29c2d4ece3 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -1,4 +1,5 @@ # New Maintainer Checklist + **This is a guide used by existing maintainers to invite new maintainers. You might find it interesting but there's nothing here users should have to know.** So, there's someone who has been making consistently high-quality contributions to Homebrew for a long time and shown themselves able to make slightly more advanced contributions than just e.g. formula updates? Let's invite them to be a maintainer! diff --git a/docs/Querying-Brew.md b/docs/Querying-Brew.md index 70fe6bb06e..6d37cb588d 100644 --- a/docs/Querying-Brew.md +++ b/docs/Querying-Brew.md @@ -1,4 +1,5 @@ # Querying `brew` + _In this document we will be using [jq](https://stedolan.github.io/jq/) to parse JSON, available from Homebrew using `brew install jq`._ ## Overview diff --git a/docs/Versions.md b/docs/Versions.md index 87bc9f5662..9e679db7dd 100644 --- a/docs/Versions.md +++ b/docs/Versions.md @@ -1,4 +1,5 @@ # Versions + Now that [Homebrew/versions](https://github.com/homebrew/homebrew-versions) has been deprecated [Homebrew/core](https://github.com/homebrew/homebrew-core) supports multiple versions of formulae with a new naming format. In [Homebrew/versions](https://github.com/homebrew/homebrew-versions) the formula for GCC 6 was named `gcc6.rb` and began `class Gcc6 < Formula`. In [Homebrew/core](https://github.com/homebrew/homebrew-core) this same formula is named `gcc@6.rb` and begins `class GccAT6 < Formula`. diff --git a/docs/brew-tap.md b/docs/brew-tap.md index f73f1813e8..15f8c79364 100644 --- a/docs/brew-tap.md +++ b/docs/brew-tap.md @@ -1,4 +1,5 @@ # Taps (third-party repositories) + `brew tap` adds more repos to the list of formulae that `brew` tracks, updates, and installs from. By default, `tap` assumes that the repos come from GitHub, but the command isn't limited to any one location. -- GitLab