aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc
diff options
context:
space:
mode:
authorDominyk Tiller2014-12-02 03:25:31 +0000
committerMike McQuaid2014-12-02 14:31:32 +0000
commit1e04a7f16a452648db7771125ebbb323da4f8862 (patch)
tree95b3afb0b06cde6fb008f31cccbad9b4c80990df /share/doc
parent88b93b7aa3e815b4398544ae52148a872b08250f (diff)
downloadbrew-1e04a7f16a452648db7771125ebbb323da4f8862.tar.bz2
Documentation Changes
More proposed documentation updates. Acceptable Formulae: * Adds Perl to the list of stuff we offer Dupes of in the Core. * Notes that OS X’s OpenSSL is usually horribly outdated. * Removes the incorrect space between font and forge. Common Issues: * We said three issues, we listed four. Oops. External Commands: * The cache is usually at /Library rather than ~/Library, and the rest of the documentation says /Library, so this makes the referencing consistent. FAQ: * Adds a tiny section on pinning formulae. Interesting-Taps-And-Branches: * Notes gaming-emulation software belongs in Homebrew/Games as well. * nolith/Embedded hasn’t been touched for 28 months. I’ve cut it. * anarchivist/forensics hasn’t been touched for 35 months. I’ve cut it. * codebutler’s GTK+ experiment seems to have been terminated after one commit. I’ve cut it. * paxam/linux hasn’t been touched for 34 months. I’ve cut it. * rmyers/homebrew hasn’t been touched in 42 months. I’ve cut it. * nddrylliog/winbrew has moved, I’ve changed the URL to the new one. Winbrew.md: * Removed. It’s referenced in the prior file, and doesn’t really need its own. Closes Homebrew/homebrew#34599. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'share/doc')
-rw-r--r--share/doc/homebrew/Acceptable-Formulae.md6
-rw-r--r--share/doc/homebrew/Common-Issues.md2
-rw-r--r--share/doc/homebrew/External-Commands.md2
-rw-r--r--share/doc/homebrew/FAQ.md9
-rw-r--r--share/doc/homebrew/Interesting-Taps-&-Branches.md23
-rw-r--r--share/doc/homebrew/Winbrew.md4
6 files changed, 18 insertions, 28 deletions
diff --git a/share/doc/homebrew/Acceptable-Formulae.md b/share/doc/homebrew/Acceptable-Formulae.md
index 232002ad2..92a25ec67 100644
--- a/share/doc/homebrew/Acceptable-Formulae.md
+++ b/share/doc/homebrew/Acceptable-Formulae.md
@@ -31,13 +31,13 @@ There are exceptions:
Formula | Reason
--- | ---
- ruby, python | People want newer versions
+ ruby, python, perl | People want newer versions
bash | OS X's bash is stuck at 3.2 because newer versions are licensed under GPLv3
zsh | This was a mistake, but it’s too late to remove it
emacs, vim | [Too popular to move to dupes](https://github.com/Homebrew/homebrew/pull/21594#issuecomment-21968819)
subversion | Originally added for 10.5, but people want the latest version
libcurl | Some formulae require a newer version than OS X provides
- openssl | OS X's openssl is deprecated
+ openssl | OS X's openssl is deprecated & outdated.
libxml2 | Historically, OS X's libxml2 has been buggy
We also maintain [a tap](https://github.com/Homebrew/homebrew-dupes) that
@@ -100,7 +100,7 @@ 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
-for OS X and/or hard to get in binary elsewhere (example: font forge).
+for OS X and/or hard to get in binary elsewhere (example: fontforge).
Check out the [homebrew-cask](https://github.com/caskroom/homebrew-cask)
project if you’d like to brew native OS X Applications.
diff --git a/share/doc/homebrew/Common-Issues.md b/share/doc/homebrew/Common-Issues.md
index dcd28196a..4a1e5371f 100644
--- a/share/doc/homebrew/Common-Issues.md
+++ b/share/doc/homebrew/Common-Issues.md
@@ -63,7 +63,7 @@ Could not open job overrides database at: /private/var/db/launchd.db/com.apple.l
launch_msg(): Socket is not connected
```
-These are likely due to one of three issues:
+These are likely due to one of four issues:
1. You are using iTerm. The solution is to use Terminal.app when interacting with `launchctl`.
2. You are using a terminal multiplexer such as `tmux` or `screen`. You should interact with `launchctl` from a separate Terminal.app shell.
diff --git a/share/doc/homebrew/External-Commands.md b/share/doc/homebrew/External-Commands.md
index 32121c78c..3c049efb2 100644
--- a/share/doc/homebrew/External-Commands.md
+++ b/share/doc/homebrew/External-Commands.md
@@ -29,7 +29,7 @@ A shell script for an command named `extcmd` should be named `brew-extcmd`. This
</tr>
<tr>
<td>HOMEBREW_CACHE</td>
- <td>Where Homebrew caches downloaded tarballs to, typically <code>~/Library/Caches/Homebrew</code>. </td>
+ <td>Where Homebrew caches downloaded tarballs to, typically <code>/Library/Caches/Homebrew</code>. </td>
</tr>
<tr>
<td>HOMEBREW_CELLAR</td>
diff --git a/share/doc/homebrew/FAQ.md b/share/doc/homebrew/FAQ.md
index a52336d8e..f090ea910 100644
--- a/share/doc/homebrew/FAQ.md
+++ b/share/doc/homebrew/FAQ.md
@@ -18,6 +18,15 @@ Or upgrade a specific formula with:
<a name="cleanup"></a>
+### How do I stop certain formulae from being updated?
+To stop something from being updated/upgraded:
+
+ brew pin $FORMULA
+
+To allow that formulae to update again:
+
+ brew unpin $FORMULA
+
### How do I uninstall old versions of a formula?
By default, Homebrew does not uninstall old versions of a formula, so
over time you will accumulate old versions. To remove them, simply use:
diff --git a/share/doc/homebrew/Interesting-Taps-&-Branches.md b/share/doc/homebrew/Interesting-Taps-&-Branches.md
index 8e137cb1c..e70e86832 100644
--- a/share/doc/homebrew/Interesting-Taps-&-Branches.md
+++ b/share/doc/homebrew/Interesting-Taps-&-Branches.md
@@ -14,7 +14,7 @@ Homebrew has the capability to add (and remove) multiple taps to your local inst
- Need e.g. older or newer versions of Python? Newer versions of GCC?
* [homebrew/games](https://github.com/Homebrew/homebrew-games)
- - Game formulae.
+ - Game or gaming-emulation related formulae.
* [homebrew/apache](https://github.com/Homebrew/homebrew-apache)
- A tap for Apache modules, extending OS X's built-in Apache. These brews may require unconventional additional setup, as explained in the caveats.
@@ -60,12 +60,6 @@ You can be added as a maintainer for one of the Homebrew organization taps and a
* [besport/ocaml](https://github.com/besport/homebrew-ocaml)
- A tap for Ocaml libraries, though with caveats, it requires you install its customized ocaml formula. Perhaps a template for more work.
-* [nolith/embedded](https://github.com/nolith/homebrew-embedded)
- - Flashing tools for embedded devices and olsrd for mesh network routing.
-
-* [anarchivist/forensics](https://github.com/anarchivist/homebrew-forensics)
- - Digital forensics-related formulae; mostly head-only, binary-only, or unstable.
-
* [petere/postgresql](https://github.com/petere/homebrew-postgresql)
- Allows installing multiple PostgreSQL versions in parallel.
@@ -80,24 +74,15 @@ You can be added as a maintainer for one of the Homebrew organization taps and a
* [mistydemeo/tigerbrew](https://github.com/mistydemeo/tigerbrew)
- Experimental Tiger PowerPC version
-* [codebutler](https://github.com/codebutler/homebrew/commits/master)
- - Preliminary support for GTK+ using the Quartz (native OS X) back-end
-
-* [paxan/linux](https://github.com/paxan/homebrew/commits/linux)
- - Experimental Linux version
-
* [homebrew/linuxbrew](https://github.com/Homebrew/linuxbrew)
- Experimental Linux version
-* [rmyers/homebrew](https://github.com/rmyers/homebrew)
- - Experimental Solaris version
-
-* [nddrylliog/winbrew](https://github.com/nddrylliog/winbrew)
- - Experimental Windows version
-
* [wilmoore/homebrew-home](https://github.com/wilmoore/homebrew-home)
- Homebrew install for those that like to Homebrew @ $HOME (i.e. ~/.homebrew).
+* [nddrylliog/homebrew-mingw](https://github.com/nddrylliog/homebrew-mingw)
+ - An experimental port of Homebrew for Windows (with an MSYS/MinGW environment).
+
## Technical Details
diff --git a/share/doc/homebrew/Winbrew.md b/share/doc/homebrew/Winbrew.md
deleted file mode 100644
index f175d3936..000000000
--- a/share/doc/homebrew/Winbrew.md
+++ /dev/null
@@ -1,4 +0,0 @@
-# Winbrew
-Winbrew is an experimental port of Homebrew for Windows (with an MSYS/MinGW environment):
-
- * https://github.com/nddrylliog/winbrew