Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for brew install and FAQ regarding HOMEBREW_NO_INSTALL_FROM_API #14570

Merged
merged 2 commits into from
Feb 14, 2023
+16 −1
Merged

Update documentation for brew install and FAQ regarding HOMEBREW_NO_INSTALL_FROM_API #14570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2daae5e
edit: add HOMEBREW_NO_INSTALL_FROM_API warning.
s4nji Feb 10, 2023
c7b8b3a
docs/FAQ: correct an entry regarding simple formula edit
s4nji Feb 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Library/Homebrew/dev-cmd/edit.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,19 @@ def edit
end.presence
end

if Homebrew::EnvConfig.automatically_set_no_install_from_api? &&
!Homebrew::EnvConfig.no_env_hints?
paths.each do |path|
next if !path.fnmatch?("**/homebrew-core/Formula/*.rb") && !path.fnmatch?("**/homebrew-cask/Casks/*.rb")

opoo <<~EOS
Unless `HOMEBREW_NO_INSTALL_FROM_API` is set when running
`brew install`, it will ignore your locally edited formula.
EOS
break
end
end

if args.print_path?
paths.each(&method(:puts))
return
Expand Down
2 changes: 1 addition & 1 deletion Library/Homebrew/test/dev-cmd/edit_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

setup_test_formula "testball"

expect { brew "edit", "testball", "HOMEBREW_EDITOR" => "/bin/cat" }
expect { brew "edit", "testball", "HOMEBREW_EDITOR" => "/bin/cat", "HOMEBREW_NO_ENV_HINTS" => "1" }
.to output(/# something here/).to_stdout
.and not_to_output.to_stderr
.and be_a_success
Expand Down
2 changes: 2 additions & 0 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ If all maintainer feedback has been addressed and all tests are passing, bump it

Yes! It’s easy! Just `brew edit <formula>`. You don’t have to submit modifications back to `homebrew/core`, just edit the formula to what you personally need and `brew install <formula>`. As a bonus, `brew update` will merge your changes with upstream so you can still keep the formula up-to-date **with** your personal modifications!

Note that if you are editing a core formula or cask you must set `HOMEBREW_NO_INSTALL_WITH_API=1` before using `brew install` or `brew update` otherwise they will ignore your local changes and default to the API.

## Can I make new formulae?

Yes! It’s easy! Just `brew create URL`. Homebrew will then open the formula in `EDITOR` so you can edit it, but it probably already installs; try it: `brew install <formula>`. If you encounter any issues, run the command with the `--debug` switch like so: `brew install --debug <formula>`, which drops you into a debugging shell.
Expand Down