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.

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

cmd/bundle: improve documentation consistency. #1579

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Conversation

MikeMcQuaid
Copy link
Member

  • address @rrotter's comment by referencing XDG_CONFIG_HOME rather than HOMEBREW_USER_CONFIG_HOME (and internal variable).
  • use environment variable names consistently.

- address #1549 (comment)
  by referencing `XDG_CONFIG_HOME` rather than
  `HOMEBREW_USER_CONFIG_HOME` (and internal variable).
- Use environment variable names consistently.
MikeMcQuaid added a commit to Homebrew/brew that referenced this pull request Jan 27, 2025
- use e.g. `$HOMEBREW_*` for cases where only the environment variable
  is the entire backtick-quoted string
- use e.g. `${HOMEBREW_*}` for cases where the environment variable is
  part of a backtick-quoted string to make clear what parts are variable
  and what parts are not
- use `export HOMEBREW_*=...` for cases where we're talking about
  setting the environment variable (because it likely needs to be
  exported to work how they want)

Inspired by Homebrew/homebrew-bundle#1579 making
similar changes for Homebrew/homebrew-bundle.
@MikeMcQuaid MikeMcQuaid enabled auto-merge January 27, 2025 13:18
@MikeMcQuaid MikeMcQuaid merged commit 9b30bb9 into master Jan 27, 2025
5 checks passed
@MikeMcQuaid MikeMcQuaid deleted the docs_consistency branch January 27, 2025 13:39
MikeMcQuaid added a commit to Homebrew/brew that referenced this pull request Jan 27, 2025
- use e.g. `$HOMEBREW_*` for cases where only the environment variable
  is the entire backtick-quoted string
- use e.g. `${HOMEBREW_*}` for cases where the environment variable is
  part of a backtick-quoted string to make clear what parts are variable
  and what parts are not
- use `export HOMEBREW_*=...` for cases where we're talking about
  setting the environment variable (because it likely needs to be
  exported to work how they want)

Inspired by Homebrew/homebrew-bundle#1579 making
similar changes for Homebrew/homebrew-bundle.
MikeMcQuaid added a commit to Homebrew/brew that referenced this pull request Jan 27, 2025
- use e.g. `$HOMEBREW_*` for cases where only the environment variable
  is the entire backtick-quoted string
- use e.g. `${HOMEBREW_*}` for cases where the environment variable is
  part of a backtick-quoted string to make clear what parts are variable
  and what parts are not
- use `export HOMEBREW_*=...` for cases where we're talking about
  setting the environment variable (because it likely needs to be
  exported to work how they want)

Inspired by Homebrew/homebrew-bundle#1579 making
similar changes for Homebrew/homebrew-bundle.
MikeMcQuaid added a commit that referenced this pull request Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants