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

Clarify accepted syntax in brew.env files in Homebrew docs #19013

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+6 −2
Open

Clarify accepted syntax in brew.env files in Homebrew docs #19013

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3270381
Clarify accepted syntax in brew.env files in Homebrew docs
pa-0 Dec 28, 2024
a7b65fe
Update Manpage.md
pa-0 Dec 28, 2024
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
8 changes: 6 additions & 2 deletions docs/Manpage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3545,8 +3545,12 @@ User-specific environment files take precedence over prefix-specific files and
prefix-specific files take precedence over system-wide files (unless
`HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY` is set, see below).

Note that these files do not support shell variable expansion e.g. `$HOME` or
command execution e.g. `$(cat file)`.
>[!IMPORTANT]
>
>Note that Homebrew's environment files are <ins>not</ins> shell scripts.
>
>- They do **not** support shell variable expansion, e.g. `$HOME` or command execution, e.g. `$(cat file)`.
>- They **cannot** parse the "`export`" command syntax, and should <ins><em>only</em></ins> contain key-value pairs, e.g. `HOMEBREW_ENV_VAR=VALUE`
Comment on lines +3548 to +3553
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be in brew.1.md.erb instead and should not contain HTML or GitHub-specific Markdown. Most of the formatting here can be trimmed to better fit the existing style.


`HOMEBREW_ALLOWED_TAPS`

Expand Down
Loading