admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Documentation Fixes

Browse Source 
The bigger, uglier brother of Homebrew/homebrew#34090.

Closes Homebrew/homebrew#34106.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
This commit is contained in:
Dominyk Tiller 2014-11-11 19:40:25 +00:00 committed by Mike McQuaid
parent f27468507c
commit e66e302c14
5 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
share/doc/homebrew/Acceptable-Formulae.md
View File

@ -6,7 +6,7 @@ own!
### We try hard to avoid dupes in Homebrew/homebrew ### We try hard to avoid dupes in Homebrew/homebrew
Stuff that comes with OS X or is a library that is provided by Stuff that comes with OS X or is a library that is provided by
[RubyGems, CPAN or PyPi](http://github.com/Homebrew/homebrew/wiki/Gems,-Eggs-and-Perl-Modules) [RubyGems, CPAN or PyPi](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Gems,-Eggs-and-Perl-Modules.md)
should not be duplicated. There are good reasons for this: should not be duplicated. There are good reasons for this:
* Duplicate libraries regularly break builds * Duplicate libraries regularly break builds
@ -97,7 +97,7 @@ 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 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 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: font forge).
Check out the [homebrew-cask](https://github.com/phinze/homebrew-cask) Check out the [homebrew-cask](https://github.com/caskroom/homebrew-cask)
project if you’d like to brew native OS X Applications. project if you’d like to brew native OS X Applications.
### Building under “superenv” is best ### Building under “superenv” is best

2
share/doc/homebrew/Common-Issues.md
View File

@ -76,7 +76,7 @@ When running `brew upgrade`, you see something like this:
$ brew upgrade $ brew upgrade
Error: undefined method `include?' for nil:NilClass Error: undefined method `include?' for nil:NilClass
Please report this bug: Please report this bug:
https://github.com/Homebrew/homebrew/wiki/checklist-before-filing-a-new-issue https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md
/usr/local/Library/Homebrew/formula.rb:393:in `canonical_name' /usr/local/Library/Homebrew/formula.rb:393:in `canonical_name'
/usr/local/Library/Homebrew/formula.rb:425:in `factory' /usr/local/Library/Homebrew/formula.rb:425:in `factory'
/usr/local/Library/Contributions/examples/brew-upgrade.rb:7 /usr/local/Library/Contributions/examples/brew-upgrade.rb:7

2
share/doc/homebrew/External-Commands.md
View File

@ -93,6 +93,6 @@ These commands have been contributed by Homebrew users but are not included in t
>Simple support to start formulae using launchctl, has out of the box support for any formula which defines `startup_plist` (e.g. mysql, postgres, redis u.v.m.): [https://gist.github.com/766293](https://gist.github.com/766293) >Simple support to start formulae using launchctl, has out of the box support for any formula which defines `startup_plist` (e.g. mysql, postgres, redis u.v.m.): [https://gist.github.com/766293](https://gist.github.com/766293)
## SEE ALSO ## SEE ALSO
Homebrew Wiki: <http://wiki.github.com/Homebrew/homebrew/> Homebrew Docs: <https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew>
`brew`(1), `which`(1), `grep`(1), [`ronn`(1)](http://rtomayko.github.com/ronn/) `brew`(1), `which`(1), `grep`(1), [`ronn`(1)](http://rtomayko.github.com/ronn/)

2
share/doc/homebrew/FAQ.md
View File

@ -170,7 +170,7 @@ creating a separate user account especially for use of Homebrew.
### Why isn’t a particular command documented? ### Why isn’t a particular command documented?
If it’s not in `man brew`, it’s probably an external command. These are documented [here](https://github.com/Homebrew/homebrew/wiki/External-Commands). If it’s not in `man brew`, it’s probably an external command. These are documented [here](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External-Commands.md).
### Why haven’t you pulled my pull request? ### Why haven’t you pulled my pull request?
If it’s been a while, bump it with a “bump” comment. Sometimes we miss requests and there are plenty of them. Maybe we were thinking on something. It will encourage consideration. In the meantime if you could rebase the pull request so that it can be cherry-picked more easily we will love you for a long time. If it’s been a while, bump it with a “bump” comment. Sometimes we miss requests and there are plenty of them. Maybe we were thinking on something. It will encourage consideration. In the meantime if you could rebase the pull request so that it can be cherry-picked more easily we will love you for a long time.

2
share/doc/homebrew/Formula-Cookbook.md
View File

@ -512,7 +512,7 @@ Instead of `git diff | pbcopy`, for some editors `git diff >> path/to/your/formu
# Advanced Formula Tricks # Advanced Formula Tricks
If anything isn’t clear, you can usually figure it out with some `grep` and the `Library/Formula` directory. Please amend this wiki page if you think it will help! If anything isn’t clear, you can usually figure it out with some `grep` and the `Library/Formula` directory. Please amend this document if you think it will help!
## Unstable versions (`HEAD`, `devel`) ## Unstable versions (`HEAD`, `devel`)