mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
Update docs, comment mxcl/homebrew refs.
This commit is contained in:
Mike McQuaid
parent
3656f59508
commit
4c2e7b1659
@ -6,7 +6,7 @@ Reporting Bugs
|
||||
Please read:
|
||||
|
||||
* `brew doctor`
|
||||
* [Troubleshooting Checklist](https://github.com/mxcl/homebrew/wiki/troubleshooting)
|
||||
* [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/wiki/troubleshooting)
|
||||
|
||||
**If you don't read these it will take us far longer to help you with your problem.**
|
||||
|
||||
@ -14,7 +14,7 @@ Contributing
|
||||
------------
|
||||
Please read:
|
||||
|
||||
* [Formula Cookbook](https://github.com/mxcl/homebrew/wiki/Formula-Cookbook)
|
||||
* [Acceptable Formulae](https://github.com/mxcl/homebrew/wiki/Acceptable-Formulae)
|
||||
* [Formula Cookbook](https://github.com/Homebrew/homebrew/wiki/Formula-Cookbook)
|
||||
* [Acceptable Formulae](https://github.com/Homebrew/homebrew/wiki/Acceptable-Formulae)
|
||||
|
||||
Thanks!
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# See: http://github.com/mxcl/homebrew/issues/issue/1359
|
||||
# See: http://github.com/Homebrew/homebrew/issues/issue/1359
|
||||
|
||||
require 'keg'
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ require 'formula'
|
||||
# This is a non-functional example formula to showcase all features and
|
||||
# therefore, its overly complex and dupes stuff just to comment on it.
|
||||
# You may want to use `brew create` to start your own new formula!
|
||||
# Documentation: https://github.com/mxcl/homebrew/wiki/Formula-Cookbook
|
||||
# Documentation: https://github.com/Homebrew/homebrew/wiki/Formula-Cookbook
|
||||
|
||||
|
||||
## Naming -- Every Homebrew formula is a class of the type `Formula`.
|
||||
@ -73,7 +73,7 @@ class ExampleFormula < Formula
|
||||
# Bottles are pre-built and added by the Homebrew maintainers for you.
|
||||
# If you maintain your own repository, you can add your own bottle links.
|
||||
# Read in the wiki about how to provide bottles:
|
||||
# <https://github.com/mxcl/homebrew/wiki/Bottles>
|
||||
# <https://github.com/Homebrew/homebrew/wiki/Bottles>
|
||||
bottle do
|
||||
root_url 'http://mikemcquaid.com' # Optional root to calculate bottle URLs
|
||||
prefix '/opt/homebrew' # Optional HOMEBREW_PREFIX in which the bottles were built.
|
||||
@ -396,7 +396,7 @@ end
|
||||
|
||||
class AdditionalStuff < Formula
|
||||
# Often, a second formula is used to download some resource
|
||||
# NOTE: This is going to change when https://github.com/mxcl/homebrew/pull/21714 happens.
|
||||
# NOTE: This is going to change when https://github.com/Homebrew/homebrew/pull/21714 happens.
|
||||
url 'https://example.com/additional-stuff.tar.gz'
|
||||
sha1 'deadbeef7890123456789012345678901234567890'
|
||||
end
|
||||
@ -404,7 +404,7 @@ end
|
||||
__END__
|
||||
# Room for a patch after the `__END__`
|
||||
# Read in the wiki about how to get a patch in here:
|
||||
# https://github.com/mxcl/homebrew/wiki/Formula-Cookbook
|
||||
# https://github.com/Homebrew/homebrew/wiki/Formula-Cookbook
|
||||
# In short, `brew install --interactive --git <formula>` and make your edits.
|
||||
# Then `git diff >> path/to/your/formula.rb`
|
||||
# Note, that HOMEBREW_PREFIX will be replaced in the path before it is
|
||||
|
||||
@ -415,7 +415,7 @@ by default:
|
||||
|
||||
Documentation for the included external commands as well as instructions for
|
||||
creating your own can be found on the wiki:
|
||||
<http://wiki.github.com/mxcl/homebrew/External-Commands>
|
||||
<http://wiki.github.com/Homebrew/homebrew/External-Commands>
|
||||
|
||||
## SPECIFYING FORMULAE
|
||||
|
||||
@ -426,13 +426,13 @@ can take several different forms:
|
||||
e.g. `git`, `node`, `wget`.
|
||||
|
||||
* The fully-qualified name of a tapped formula:
|
||||
Sometimes a formula from a tapped repository may conflict with one in mxcl/master.
|
||||
Sometimes a formula from a tapped repository may conflict with one in Homebrew/homebrew.
|
||||
You can still access these formulae by using a special syntax, e.g.
|
||||
`homebrew/dupes/vim` or `homebrew/versions/node4`.
|
||||
|
||||
* An arbitrary URL:
|
||||
Homebrew can install formulae via URL, e.g.
|
||||
`https://raw.github.com/mxcl/homebrew/master/Library/Formula/git.rb`.
|
||||
`https://raw.github.com/Homebrew/homebrew/master/Library/Formula/git.rb`.
|
||||
The formula file will be cached for later use.
|
||||
|
||||
## ENVIRONMENT
|
||||
@ -578,7 +578,7 @@ If your proxy requires authentication:
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
Homebrew Wiki: <http://wiki.github.com/mxcl/homebrew/>
|
||||
Homebrew Wiki: <http://wiki.github.com/Homebrew/homebrew/>
|
||||
|
||||
`git`(1), `git-log`(1)
|
||||
|
||||
@ -588,5 +588,5 @@ Max Howell, a splendid chap.
|
||||
|
||||
## BUGS
|
||||
|
||||
See Issues on GitHub: <http://github.com/mxcl/homebrew/issues>
|
||||
See Issues on GitHub: <http://github.com/Homebrew/homebrew/issues>
|
||||
|
||||
|
||||
@ -117,7 +117,7 @@ class FormulaCreator
|
||||
def template; <<-EOS.undent
|
||||
require 'formula'
|
||||
|
||||
# Documentation: https://github.com/mxcl/homebrew/wiki/Formula-Cookbook
|
||||
# Documentation: https://github.com/Homebrew/homebrew/wiki/Formula-Cookbook
|
||||
# #{HOMEBREW_CONTRIB}/example-formula.rb
|
||||
# PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ class Checks
|
||||
############# END HELPERS
|
||||
|
||||
# Sorry for the lack of an indent here, the diff would have been unreadable.
|
||||
# See https://github.com/mxcl/homebrew/pull/9986
|
||||
# See https://github.com/Homebrew/homebrew/pull/9986
|
||||
def check_path_for_trailing_slashes
|
||||
bad_paths = ENV['PATH'].split(File::PATH_SEPARATOR).select { |p| p[-1..-1] == '/' }
|
||||
return if bad_paths.empty?
|
||||
|
||||
@ -343,7 +343,7 @@ class Formula
|
||||
# Install python bindings inside of a block given to this method and/or
|
||||
# call python so: `system python, "setup.py", "install", "--prefix=#{prefix}"
|
||||
# Note that there are no quotation marks around python!
|
||||
# <https://github.com/mxcl/homebrew/wiki/Homebrew-and-Python>
|
||||
# <https://github.com/Homebrew/homebrew/wiki/Homebrew-and-Python>
|
||||
def python(options={:allowed_major_versions => [2, 3]}, &block)
|
||||
require 'python_helper'
|
||||
python_helper(options, &block)
|
||||
|
||||
@ -180,9 +180,9 @@ module OS
|
||||
end
|
||||
|
||||
# See these issues for some history:
|
||||
# http://github.com/mxcl/homebrew/issues/#issue/13
|
||||
# http://github.com/mxcl/homebrew/issues/#issue/41
|
||||
# http://github.com/mxcl/homebrew/issues/#issue/48
|
||||
# http://github.com/Homebrew/homebrew/issues/13
|
||||
# http://github.com/Homebrew/homebrew/issues/41
|
||||
# http://github.com/Homebrew/homebrew/issues/48
|
||||
def macports_or_fink
|
||||
paths = []
|
||||
|
||||
|
||||
@ -108,7 +108,7 @@ module OS
|
||||
rescue
|
||||
# For people who's xcode-select is unset, or who have installed
|
||||
# xcode-gcc-installer or whatever other combinations we can try and
|
||||
# supprt. See https://github.com/mxcl/homebrew/wiki/Xcode
|
||||
# supprt. See https://github.com/Homebrew/homebrew/wiki/Xcode
|
||||
case MacOS.llvm_build_version.to_i
|
||||
when 1..2063 then "3.1.0"
|
||||
when 2064..2065 then "3.1.4"
|
||||
@ -121,7 +121,7 @@ module OS
|
||||
when 2327..2333 then "3.2.5"
|
||||
when 2335
|
||||
# this build number applies to 3.2.6, 4.0 and 4.1
|
||||
# https://github.com/mxcl/homebrew/wiki/Xcode
|
||||
# https://github.com/Homebrew/homebrew/wiki/Xcode
|
||||
"4.0"
|
||||
else
|
||||
case (MacOS.clang_version.to_f * 10).to_i
|
||||
|
||||
@ -295,7 +295,7 @@ class PythonDependency < Requirement
|
||||
<<-EOF.undent
|
||||
# This file is created by Homebrew and is executed on each python startup.
|
||||
# Don't print from here, or else python command line scripts may fail!
|
||||
# <https://github.com/mxcl/homebrew/wiki/Homebrew-and-Python>
|
||||
# <https://github.com/Homebrew/homebrew/wiki/Homebrew-and-Python>
|
||||
import os
|
||||
import sys
|
||||
|
||||
|
||||
@ -137,7 +137,7 @@ def curl *args
|
||||
raise "#{curl} is not executable" unless curl.exist? and curl.executable?
|
||||
|
||||
args = [HOMEBREW_CURL_ARGS, HOMEBREW_USER_AGENT, *args]
|
||||
# See https://github.com/mxcl/homebrew/issues/6103
|
||||
# See https://github.com/Homebrew/homebrew/issues/6103
|
||||
args << "--insecure" if MacOS.version < "10.6"
|
||||
args << "--verbose" if ENV['HOMEBREW_CURL_VERBOSE']
|
||||
args << "--silent" unless $stdout.tty?
|
||||
|
||||
@ -22,8 +22,8 @@ License
|
||||
Code is under the [BSD 2 Clause (NetBSD) license][license].
|
||||
|
||||
[home]:http://brew.sh
|
||||
[wiki]:http://wiki.github.com/mxcl/homebrew
|
||||
[wiki]:http://wiki.github.com/Homebrew/homebrew
|
||||
[mxcl]:http://twitter.com/mxcl
|
||||
[formula]:http://github.com/mxcl/homebrew/tree/master/Library/Formula/
|
||||
[formula]:http://github.com/Homebrew/homebrew/tree/master/Library/Formula/
|
||||
[braumeister]:http://braumeister.org
|
||||
[license]:https://github.com/mxcl/homebrew/tree/master/Library/Homebrew/LICENSE
|
||||
[license]:https://github.com/Homebrew/homebrew/tree/master/Library/Homebrew/LICENSE
|
||||
|
||||
@ -453,7 +453,7 @@ $ ls $(brew \-\-repository)/Library/Contributions/cmd
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Documentation for the included external commands as well as instructions for creating your own can be found on the wiki: \fIhttp://wiki\.github\.com/mxcl/homebrew/External\-Commands\fR
|
||||
Documentation for the included external commands as well as instructions for creating your own can be found on the wiki: \fIhttp://wiki\.github\.com/Homebrew/homebrew/External\-Commands\fR
|
||||
.
|
||||
.SH "SPECIFYING FORMULAE"
|
||||
Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms:
|
||||
@ -464,11 +464,11 @@ e\.g\. \fBgit\fR, \fBnode\fR, \fBwget\fR\.
|
||||
.
|
||||
.TP
|
||||
The fully\-qualified name of a tapped formula
|
||||
Sometimes a formula from a tapped repository may conflict with one in mxcl/master\. You can still access these formulae by using a special syntax, e\.g\. \fBhomebrew/dupes/vim\fR or \fBhomebrew/versions/node4\fR\.
|
||||
Sometimes a formula from a tapped repository may conflict with one in Homebrew/homebrew\. You can still access these formulae by using a special syntax, e\.g\. \fBhomebrew/dupes/vim\fR or \fBhomebrew/versions/node4\fR\.
|
||||
.
|
||||
.TP
|
||||
An arbitrary URL
|
||||
Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.github\.com/mxcl/homebrew/master/Library/Formula/git\.rb\fR\. The formula file will be cached for later use\.
|
||||
Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.github\.com/Homebrew/homebrew/master/Library/Formula/git\.rb\fR\. The formula file will be cached for later use\.
|
||||
.
|
||||
.SH "ENVIRONMENT"
|
||||
.
|
||||
@ -625,7 +625,7 @@ http_proxy=http://<user>:<password>@<host>:<port> brew install foo
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
Homebrew Wiki: \fIhttp://wiki\.github\.com/mxcl/homebrew/\fR
|
||||
Homebrew Wiki: \fIhttp://wiki\.github\.com/Homebrew/homebrew/\fR
|
||||
.
|
||||
.P
|
||||
\fBgit\fR(1), \fBgit\-log\fR(1)
|
||||
@ -634,4 +634,4 @@ Homebrew Wiki: \fIhttp://wiki\.github\.com/mxcl/homebrew/\fR
|
||||
Max Howell, a splendid chap\.
|
||||
.
|
||||
.SH "BUGS"
|
||||
See Issues on GitHub: \fIhttp://github\.com/mxcl/homebrew/issues\fR
|
||||
See Issues on GitHub: \fIhttp://github\.com/Homebrew/homebrew/issues\fR
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user