diff options
| author | Mike McQuaid | 2015-10-26 21:04:12 -0600 |
|---|---|---|
| committer | Mike McQuaid | 2015-10-27 10:45:23 -0600 |
| commit | 74e407dc548f397159ee0eab6d0921bd0666b3b3 (patch) | |
| tree | d1b35fc3864fd1f2b10e14ee9b8b75d7e995eb65 /Library/Homebrew | |
| parent | 8ea9903a99fce3d7bcd432200f1bd2170e81de43 (diff) | |
| download | brew-74e407dc548f397159ee0eab6d0921bd0666b3b3.tar.bz2 | |
The Formula API is no longer work-in-progress.
Feature it a bit more prominently in the documentation as a result.
Closes Homebrew/homebrew#45374.
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'Library/Homebrew')
| -rw-r--r-- | Library/Homebrew/README.md | 2 | ||||
| -rw-r--r-- | Library/Homebrew/cmd/create.rb | 2 | ||||
| -rw-r--r-- | Library/Homebrew/manpages/brew.1.md | 4 |
3 files changed, 4 insertions, 4 deletions
diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md index 00036f131..562335de4 100644 --- a/Library/Homebrew/README.md +++ b/Library/Homebrew/README.md @@ -1,5 +1,5 @@ # Homebrew's Formula API -This is the (partially) documented public API for Homebrew. It's currently a work in progress. Sorry about that! +This is the (partially) documented public API for Homebrew. The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private. diff --git a/Library/Homebrew/cmd/create.rb b/Library/Homebrew/cmd/create.rb index e83c9facd..b64f3c10b 100644 --- a/Library/Homebrew/cmd/create.rb +++ b/Library/Homebrew/cmd/create.rb @@ -118,7 +118,7 @@ class FormulaCreator def template; <<-EOS.undent # Documentation: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md - # http://www.rubydoc.info/github/Homebrew/homebrew/master/frames + # http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula # PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST! class #{Formulary.class_s(name)} < Formula diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md index 561ce9a74..c36219a58 100644 --- a/Library/Homebrew/manpages/brew.1.md +++ b/Library/Homebrew/manpages/brew.1.md @@ -90,9 +90,9 @@ Note that these flags should only appear after a command. Generate a formula for the downloadable file at <URL> and open it in the editor. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you'll have to make your own template. The wget - formula serves as a simple example. For a complete cheat-sheet, have a look at + formula serves as a simple example. For the complete API have a look at - <http://www.rubydoc.info/github/Homebrew/homebrew/master/frames> + <http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula> If `--autotools` is passed, create a basic template for an Autotools-style build. If `--cmake` is passed, create a basic template for a CMake-style build. |