diff --git a/docs/Bottles.md b/docs/Bottles.md index 0f337dc825..b0d68f4860 100644 --- a/docs/Bottles.md +++ b/docs/Bottles.md @@ -10,7 +10,7 @@ Bottles will not be used if the user requests it (see above), if the formula req ## Creation Bottles are created using the [Brew Test Bot](Brew-Test-Bot.md). This happens mostly when people submit pull requests to Homebrew and the `bottle do` block is updated by maintainers when they `brew pull --bottle` the contents of a pull request. For the Homebrew organisations' taps they are uploaded to and downloaded from [Bintray](https://bintray.com/homebrew). -By default, bottles will be built for the oldest CPU supported by the OS/architecture you're building for (Core 2 for 64-bit OSs). This ensures that bottles are compatible with all computers you might distribute them to. If you *really* want your bottles to be optimized for something else, you can pass the `--bottle-arch=` option to build for another architecture; for example, `brew install foo --build-bottle --bottle-arch=penryn`. Just remember that if you build for a newer architecture some of your users might get binaries they can't run and that would be sad! +By default, bottles will be built for the oldest CPU supported by the OS/architecture you're building for (Core 2 for 64-bit OSs). This ensures that bottles are compatible with all computers you might distribute them to. If you *really* want your bottles to be optimised for something else, you can pass the `--bottle-arch=` option to build for another architecture; for example, `brew install foo --build-bottle --bottle-arch=penryn`. Just remember that if you build for a newer architecture some of your users might get binaries they can't run and that would be sad! ## Format Bottles are simple gzipped tarballs of compiled binaries. Any metadata is stored in a formula's bottle DSL and in the bottle filename (i.e. macOS version, revision). diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index c80b398ffc..e82499dc16 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -84,7 +84,7 @@ so you can override this with `brew create --set-name `. An SSL/TLS (https) [`homepage`](https://rubydoc.brew.sh/Formula#homepage%3D-class_method) is preferred, if one is available. -Try to summarize from the [`homepage`](https://rubydoc.brew.sh/Formula#homepage%3D-class_method) what the formula does in the [`desc`](https://rubydoc.brew.sh/Formula#desc%3D-class_method)ription. Note that the [`desc`](https://rubydoc.brew.sh/Formula#desc%3D-class_method)ription is automatically prepended with the formula name. +Try to summarise from the [`homepage`](https://rubydoc.brew.sh/Formula#homepage%3D-class_method) what the formula does in the [`desc`](https://rubydoc.brew.sh/Formula#desc%3D-class_method)ription. Note that the [`desc`](https://rubydoc.brew.sh/Formula#desc%3D-class_method)ription is automatically prepended with the formula name. ### Check the build system @@ -332,7 +332,7 @@ correct. Add an explicit [`version`](https://rubydoc.brew.sh/Formula#version-cla Everything is built on Git, so contribution is easy: ```sh -brew update # required in more ways than you think (initializes the brew git repository if you don't already have it) +brew update # required in more ways than you think (initialises the brew git repository if you don't already have it) cd $(brew --repo homebrew/core) # Create a new git branch for your formula so your pull request is easy to # modify if any changes come up during review. @@ -790,7 +790,7 @@ Some software requires a Fortran compiler. This can be declared by adding `depen ## MPI -Formula requiring MPI should use [OpenMPI](https://www.open-mpi.org/) by adding `depends_on "open-mpi"` to the formula, rather than [MPICH](https://www.mpich.org/). These packages have conflicts and provide the same standardized interfaces. Choosing a default implementation and requiring it to be adopted allows software to link against multiple libraries that rely on MPI without creating un-anticipated incompatibilities due to differing MPI runtimes. +Formula requiring MPI should use [OpenMPI](https://www.open-mpi.org/) by adding `depends_on "open-mpi"` to the formula, rather than [MPICH](https://www.mpich.org/). These packages have conflicts and provide the same standardised interfaces. Choosing a default implementation and requiring it to be adopted allows software to link against multiple libraries that rely on MPI without creating un-anticipated incompatibilities due to differing MPI runtimes. ## Linear algebra libraries diff --git a/docs/Homebrew-and-Python.md b/docs/Homebrew-and-Python.md index aaf836ab1e..a5b5c79ab4 100644 --- a/docs/Homebrew-and-Python.md +++ b/docs/Homebrew-and-Python.md @@ -11,7 +11,7 @@ Homebrew provides formulae to brew Python 3.x and a more up-to-date Python 2.7.x ## Python 3.x or Python 2.x Homebrew provides one formula for Python 3.x (`python`) and another for Python 2.7.x (`python@2`). -The executables are organized as follows so that Python 2 and Python 3 can both be installed without conflict: +The executables are organised as follows so that Python 2 and Python 3 can both be installed without conflict: * `python3` points to Homebrew's Python 3.x (if installed) * `python2` points to Homebrew's Python 2.7.x (if installed) diff --git a/docs/Homebrew-linuxbrew-core-Maintainer-Guide.md b/docs/Homebrew-linuxbrew-core-Maintainer-Guide.md index 5b09ee21ce..6afe59ae39 100644 --- a/docs/Homebrew-linuxbrew-core-Maintainer-Guide.md +++ b/docs/Homebrew-linuxbrew-core-Maintainer-Guide.md @@ -203,7 +203,7 @@ This is due to a bug with Azure Pipelines and its handling of merge commits. Master branch builds also fail for the same reason. This is OK. -Once the PR is approved by other Homebrew developers, you can finalize +Once the PR is approved by other Homebrew developers, you can finalise the merge with: ```bash