From 74e407dc548f397159ee0eab6d0921bd0666b3b3 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Mon, 26 Oct 2015 21:04:12 -0600 Subject: 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 --- Library/Homebrew/README.md | 2 +- Library/Homebrew/cmd/create.rb | 2 +- Library/Homebrew/manpages/brew.1.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) (limited to 'Library/Homebrew') 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 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 - + 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. -- cgit v1.2.3