Skip to content

Commit

Permalink
Various edits for punctuation, grammar, spelling, etc.
Browse files Browse the repository at this point in the history
Closes Homebrew#40478.

Signed-off-by: Dominyk Tiller <[email protected]>
  • Loading branch information
L2G authored and DomT4 committed Jun 10, 2015
1 parent 17a37c1 commit ace0d8f
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 31 deletions.
12 changes: 6 additions & 6 deletions Library/Contributions/example-formula.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class ExampleFormula < Formula
revision 1 # This is used when there's no new version but it needs recompiling for another reason.
# 0 is default & unwritten.

# The url of the archive. Prefer https (security and proxy issues):
# The URL of the archive. Prefer https (security and proxy issues):
url "https://packed.sources.and.we.prefer.https.example.com/archive-1.2.3.tar.bz2"
mirror "https://in.case.the.host.is.down.example.com" # `mirror` is optional.
mirror "https://in.case.the.mirror.is.down.example.com" # Mirrors are limitless, but don't go too wild.
Expand Down Expand Up @@ -80,8 +80,8 @@ class ExampleFormula < Formula
# To use another software: `"with-other-software"` or `"without-foo"`
# Note, that for dependencies that are `:optional` or `:recommended`, options
# are generated automatically.
# Build a universal (On newer intel Macs this means a combined 32bit and
# 64bit binary/library). LATER: better explain what this means for PPC.
# Build a universal (On newer Intel Macs this means a combined 32-bit and
# 64-bit binary/library). LATER: better explain what this means for PPC.
option :universal
option "with-spam", "The description goes here without a dot at the end"
option "with-qt", "Text here overwrites the autogenerated one from `depends_on 'qt'`"
Expand Down Expand Up @@ -112,7 +112,7 @@ def pour_bottle?
## keg_only

# Software that will not be sym-linked into the `brew --prefix` will only
# live in it's Cellar. Other formulae can depend on it and then brew will
# live in its Cellar. Other formulae can depend on it and then brew will
# add the necessary includes and libs (etc.) during the brewing of that
# other formula. But generally, keg_only formulae are not in your PATH
# and not seen by compilers if you build your own software outside of
Expand Down Expand Up @@ -154,8 +154,8 @@ def pour_bottle?
depends_on :mpi => [:cc, :cxx, :optional] # Is optional. MPI with `cc` and `cxx`.
depends_on :macos => :lion # Needs at least Mac OS X "Lion" aka. 10.7.
depends_on :apr # If a formula requires the CLT-provided apr library to exist.
depends_on :arch => :intel # If this formula only builds on intel architecture.
depends_on :arch => :x86_64 # If this formula only build on intel x86 64bit.
depends_on :arch => :intel # If this formula only builds on Intel architecture.
depends_on :arch => :x86_64 # If this formula only builds on Intel x86 64-bit.
depends_on :arch => :ppc # Only builds on PowerPC?
depends_on :ld64 # Sometimes ld fails on `MacOS.version < :leopard`. Then use this.
depends_on :x11 # X11/XQuartz components. Non-optional X11 deps should go in Homebrew/Homebrew-x11
Expand Down
12 changes: 6 additions & 6 deletions Library/Homebrew/cmd/audit.rb
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,12 @@ def audit_formula_name
full_name = formula.full_name

if @@aliases.include? name
problem "Formula name is conflicted with existed aliases."
problem "Formula name conflicts with existing aliases."
return
end

if !formula.core_formula? && Formula.core_names.include?(name)
problem "Formula name is conflicted with existed core formula."
problem "Formula name conflicts with existing core formula."
return
end

Expand All @@ -217,7 +217,7 @@ def audit_formula_name
same_name_tap_formulae.delete(full_name)

if same_name_tap_formulae.size > 0
problem "Formula name is conflicted with #{same_name_tap_formulae.join ", "}"
problem "Formula name conflicts with #{same_name_tap_formulae.join ", "}"
end
end

Expand Down Expand Up @@ -355,7 +355,7 @@ def audit_homepage
end

# Freedesktop is complicated to handle - It has SSL/TLS, but only on certain subdomains.
# To enable https Freedesktop change the url from http://project.freedesktop.org/wiki to
# To enable https Freedesktop change the URL from http://project.freedesktop.org/wiki to
# https://wiki.freedesktop.org/project_name.
# "Software" is redirected to https://wiki.freedesktop.org/www/Software/project_name
if homepage =~ %r[^http://((?:www|nice|libopenraw|liboil|telepathy|xorg)\.)?freedesktop\.org/(?:wiki/)?]
Expand Down Expand Up @@ -511,7 +511,7 @@ def audit_line(line, lineno)
if line =~ /# if this fails, try separate make\/make install steps/
problem "Please remove default template comments"
end
if line =~ /# The url of the archive/
if line =~ /# The URL of the archive/
problem "Please remove default template comments"
end
if line =~ /## Naming --/
Expand Down Expand Up @@ -848,7 +848,7 @@ def audit_version
end

if version.to_s =~ /_\d+$/
problem "version #{version} should not end with a underline and a number"
problem "version #{version} should not end with an underline and a number"
end
end

Expand Down
4 changes: 2 additions & 2 deletions Library/Homebrew/manpages/brew.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Note that these flags should only appear after a command.
If `--HEAD` or `--devel` is passed, fetch that version instead of the
stable version.

If `-v` is passed, do a verbose VCS checkout, if the url represents a CVS.
If `-v` is passed, do a verbose VCS checkout, if the URL represents a CVS.
This is useful for seeing if an existing VCS cache has been updated.

If `--force` is passed, remove a previously cached version and re-fetch.
Expand Down Expand Up @@ -236,7 +236,7 @@ Note that these flags should only appear after a command.

* `ln`, `link [--overwrite] [--dry-run] [--force]` <formula>:
Symlink all of <formula>'s installed files into the Homebrew prefix. This
is done automatically when you install formula, but can be useful for DIY
is done automatically when you install formulae but can be useful for DIY
installations.

If `--overwrite` is passed, Homebrew will delete files which already exist in
Expand Down
6 changes: 3 additions & 3 deletions Library/Homebrew/tap_constants.rb
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# match expressions when taps are given as ARGS, e.g. someuser/sometap
HOMEBREW_TAP_ARGS_REGEX = %r{^([\w-]+)/(homebrew-)?([\w-]+)$}
# match taps' formula, e.g. someuser/sometap/someformula
# match taps' formulae, e.g. someuser/sometap/someformula
HOMEBREW_TAP_FORMULA_REGEX = %r{^([\w-]+)/([\w-]+)/([\w+-.]+)$}
# match taps' directory path, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap
# match taps' directory paths, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap
HOMEBREW_TAP_DIR_REGEX = %r{#{Regexp.escape(HOMEBREW_LIBRARY.to_s)}/Taps/([\w-]+)/([\w-]+)}
# match taps' formula path, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap/someformula
# match taps' formula paths, e.g. HOMEBREW_LIBRARY/Taps/someuser/sometap/someformula
HOMEBREW_TAP_PATH_REGEX = Regexp.new(HOMEBREW_TAP_DIR_REGEX.source + %r{/(.*)}.source)
# match the default brew-cask tap e.g. Caskroom/cask
HOMEBREW_CASK_TAP_FORMULA_REGEX = %r{^(Caskroom)/(cask)/([\w+-.]+)$}
2 changes: 1 addition & 1 deletion share/doc/homebrew/Acceptable-Formulae.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Please trust that we need to use our discretion based on our experience
running a package manager.

### Stuff that builds a .app
Don’t make your formula build an `.app` (native OS X Application), we
Don’t make your formula build an `.app` (native OS X Application); we
don’t want those things in Homebrew. Make it build a command line tool
or a library. However, we have a few exceptions to that, e.g. when the
App is just additional to CLI or if the GUI-application is non-native
Expand Down
12 changes: 6 additions & 6 deletions share/doc/homebrew/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,12 @@ Yes! It’s easy! Just `brew edit $FORMULA`. You don’t have to submit modifica
### Can I make new formulae?
Yes! It’s easy! Just `brew create URL` Homebrew will then open the
formula in `$EDITOR` so you can edit it, but it probably already
installs, try it: `brew install $FORMULA`. If you come up any issues,
run the command with the `-d` switch like so: `brew install -d $FORMULA`
installs; try it: `brew install $FORMULA`. If you come up with any issues,
run the command with the `-d` switch like so: `brew install -d $FORMULA`,
which drops you into a debugging shell.

If you want your new formula to be part of *Homebrew/homebrew* or want
to learn more about writing formula then please read the [Formula Cookbook](Formula-Cookbook.md).
to learn more about writing formulae, then please read the [Formula Cookbook](Formula-Cookbook.md).

### Can I install my own stuff to `/usr/local`?
Yes, brew is designed to not get in your way so you can use it how you
Expand Down Expand Up @@ -218,7 +218,7 @@ Linking /usr/local/Cellar/foo/0.1… 17 symlinks created
### Where was a formula deleted?
Use `brew log $FORMULA` to find out!

Sometimes formula are moved to specialized repositories. These are the
Sometimes formulae are moved to specialized repositories. These are the
likely candidates:

* [https://github.com/Homebrew/homebrew-dupes](https://github.com/Homebrew/homebrew-dupes)
Expand All @@ -241,9 +241,9 @@ late. However, today, the first google hit for “homebrew” is not beer
related ;-)

### What does *keg-only* mean?
It means the formula is installed only into the Cellar, it is not linked
It means the formula is installed only into the Cellar; it is not linked
into `/usr/local`. This means most tools will not find it. We don’t do
this for stupid reasons. You can link the formula in still if you need
this for stupid reasons. You can still link in the formula if you need
to with `brew link`.

### How can I specify different configure arguments for a formula?
Expand Down
8 changes: 4 additions & 4 deletions share/doc/homebrew/Formula-Cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ We try to not duplicate libraries and complicated tools in core Homebrew. We dup

The one special exception is OpenSSL. Anything that uses OpenSSL *should* be built using Homebrew’s shipped OpenSSL and our test bot's post-install audit will warn of this when it is detected. (*Of course, there are exceptions to the exception. Not everything can be forced onto our OpenSSL)*.

Because Homebrew’s OpenSSL is `keg_only` to avoid conflicting with the system sometimes formulae need to have environmental variables set or special configuration flags passed to locate our preferred OpenSSL; you can see this mechanism in the [clamav](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/clamav.rb#L28) formula. Usually this is unnecessary because when OpenSSL is specified as a dependency Homebrew temporarily prepends the $PATH with that prefix.
Because Homebrew’s OpenSSL is `keg_only` to avoid conflicting with the system, sometimes formulae need to have environmental variables set or special configuration flags passed to locate our preferred OpenSSL; you can see this mechanism in the [clamav](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/clamav.rb#L28) formula. Usually this is unnecessary because when OpenSSL is specified as a dependency Homebrew temporarily prepends the $PATH with that prefix.

Homebrew maintains a special [tap that provides other useful dupes](https://github.com/Homebrew/homebrew-dupes).

Expand Down Expand Up @@ -228,7 +228,7 @@ Where a dependent of a formula fails against a new version of that dependency it

## Double-check for dependencies

When you already have a lot of brews installed, its easy to miss a common dependency like `glib` or `gettext`.
When you already have a lot of brews installed, it's easy to miss a common dependency like `glib` or `gettext`.
You can double-check which libraries a binary links to with the `otool` command (perhaps you need to use `xcrun otool`):
Expand Down Expand Up @@ -265,7 +265,7 @@ class Foo < Formula
end
```

[jrnl](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/jrnl.rb) is an example of a formula that does this well. The end-result means the user doesn't have to faff with `pip` or Python and can just run `jrnl`.
[jrnl](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/jrnl.rb) is an example of a formula that does this well. The end result means the user doesn't have to faff with `pip` or Python and can just run `jrnl`.
[homebrew-pypi-poet](https://github.com/tdsmith/homebrew-pypi-poet) can help you generate resource stanzas for the dependencies of your Python application.
Expand Down Expand Up @@ -364,7 +364,7 @@ The established standard for Git commit messages is:
* two (2) newlines, then
* explain the commit throughly

At Homebrew, we like to put the name of the formula upfront like so "foobar 7.3 (new formula)".
At Homebrew, we like to put the name of the formula up front like so: "foobar 7.3 (new formula)".
This may seem crazy short, but you’ll find that forcing yourself to summarise the commit encourages you to be atomic and concise. If you can’t summarise it in 50-80 characters, you’re probably trying to commit two commits as one. For a more thorough explanation, please read Tim Pope’s excellent blog post, [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

The preferred commit message format for simple version updates is "foobar 7.3".
Expand Down
6 changes: 3 additions & 3 deletions share/man/man1/brew.1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW" "1" "May 2015" "Homebrew" "brew"
.TH "BREW" "1" "June 2015" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The missing package manager for OS X
Expand Down Expand Up @@ -155,7 +155,7 @@ Download the source packages for the given \fIformulae\fR\. For tarballs, also p
If \fB\-\-HEAD\fR or \fB\-\-devel\fR is passed, fetch that version instead of the stable version\.
.
.IP
If \fB\-v\fR is passed, do a verbose VCS checkout, if the url represents a CVS\. This is useful for seeing if an existing VCS cache has been updated\.
If \fB\-v\fR is passed, do a verbose VCS checkout, if the URL represents a CVS\. This is useful for seeing if an existing VCS cache has been updated\.
.
.IP
If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\.
Expand Down Expand Up @@ -255,7 +255,7 @@ Show installed formulae that are not dependencies of another installed formula\.
.
.TP
\fBln\fR, \fBlink [\-\-overwrite] [\-\-dry\-run] [\-\-force]\fR \fIformula\fR
Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formula, but can be useful for DIY installations\.
Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.
.IP
If \fB\-\-overwrite\fR is passed, Homebrew will delete files which already exist in the prefix while linking\.
Expand Down

0 comments on commit ace0d8f

Please sign in to comment.