From 1e57ca70d34ed2504aadbbb2b40bef88a5f781df Mon Sep 17 00:00:00 2001 From: R Primus Date: Wed, 30 Oct 2019 18:03:31 +0000 Subject: [PATCH 1/2] Replace American spelling with British spelling --- docs/Bottles.md | 2 +- docs/Formula-Cookbook.md | 6 +++--- docs/Homebrew-and-Python.md | 2 +- docs/Homebrew-linuxbrew-core-Maintainer-Guide.md | 2 +- docs/Manpage.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) 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 diff --git a/docs/Manpage.md b/docs/Manpage.md index 8838ffc578..82a4e5e08e 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -292,7 +292,7 @@ automatically when you install formulae but can be useful for DIY installations. List all installed formulae. -If *`formula`* is provided, summarize the paths within its current keg. +If *`formula`* is provided, summarise the paths within its current keg. * `--full-name`: Print formulae with fully-qualified names. If `--full-name` is not passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) which produces the actual output. @@ -646,7 +646,7 @@ would be installed, without any sort of versioned directory as the last path. ### `--env` [*`options`*] -Summarize Homebrew's build environment as a plain list. +Summarise Homebrew's build environment as a plain list. If the command's output is sent through a pipe and no shell is specified, the list is formatted for export to `bash`(1) unless `--plain` is passed. From 5ffc7e9d668c8be4bc9bd40ab45f3e1c6a9bd2fe Mon Sep 17 00:00:00 2001 From: R Primus Date: Wed, 30 Oct 2019 18:52:02 +0000 Subject: [PATCH 2/2] Change spelling of [Ss]ummarize to British english --- Library/Homebrew/cmd/--env.rb | 2 +- Library/Homebrew/cmd/list.rb | 2 +- docs/Manpage.md | 4 ++-- manpages/brew.1 | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Library/Homebrew/cmd/--env.rb b/Library/Homebrew/cmd/--env.rb index a96ddf6dda..f1c3e3e94f 100644 --- a/Library/Homebrew/cmd/--env.rb +++ b/Library/Homebrew/cmd/--env.rb @@ -13,7 +13,7 @@ module Homebrew usage_banner <<~EOS `--env` [] - Summarize Homebrew's build environment as a plain list. + Summarise Homebrew's build environment as a plain list. If the command's output is sent through a pipe and no shell is specified, the list is formatted for export to `bash`(1) unless `--plain` is passed. diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index a6cd43d331..3a1eb4881c 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -14,7 +14,7 @@ module Homebrew List all installed formulae. - If is provided, summarize the paths within its current keg. + If is provided, summarise the paths within its current keg. EOS switch "--full-name", description: "Print formulae with fully-qualified names. If `--full-name` is not "\ diff --git a/docs/Manpage.md b/docs/Manpage.md index 8838ffc578..82a4e5e08e 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -292,7 +292,7 @@ automatically when you install formulae but can be useful for DIY installations. List all installed formulae. -If *`formula`* is provided, summarize the paths within its current keg. +If *`formula`* is provided, summarise the paths within its current keg. * `--full-name`: Print formulae with fully-qualified names. If `--full-name` is not passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) which produces the actual output. @@ -646,7 +646,7 @@ would be installed, without any sort of versioned directory as the last path. ### `--env` [*`options`*] -Summarize Homebrew's build environment as a plain list. +Summarise Homebrew's build environment as a plain list. If the command's output is sent through a pipe and no shell is specified, the list is formatted for export to `bash`(1) unless `--plain` is passed. diff --git a/manpages/brew.1 b/manpages/brew.1 index 14adb9309f..a4dbbf59a3 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -381,7 +381,7 @@ Allow keg\-only formulae to be linked\. List all installed formulae\. . .P -If \fIformula\fR is provided, summarize the paths within its current keg\. +If \fIformula\fR is provided, summarise the paths within its current keg\. . .TP \fB\-\-full\-name\fR @@ -813,7 +813,7 @@ Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\. . .SS "\fB\-\-env\fR [\fIoptions\fR]" -Summarize Homebrew\'s build environment as a plain list\. +Summarise Homebrew\'s build environment as a plain list\. . .P If the command\'s output is sent through a pipe and no shell is specified, the list is formatted for export to \fBbash\fR(1) unless \fB\-\-plain\fR is passed\.