From 9e4fb40f92ed2acadc82909cc3bc4b2d66467c2d Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Thu, 25 Oct 2018 09:24:00 -0400 Subject: [PATCH] docs: update descriptions of git- and curl-related vars Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable. --- Library/Homebrew/manpages/brew.1.md.erb | 17 ++++++----------- Library/Homebrew/shims/scm/git | 2 +- docs/Manpage.md | 17 ++++++----------- manpages/brew.1 | 11 ++--------- 4 files changed, 15 insertions(+), 32 deletions(-) diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index b17b10a47a..3488c08878 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -10,7 +10,7 @@ # When done, regenerate the man page and its HTML version by running `brew man`. %> brew(1) -- The missing package manager for macOS -=============================================== +================================================ ## SYNOPSIS @@ -105,6 +105,7 @@ can take several different forms: The formula file will be cached for later use. ## ENVIRONMENT + Note that environment variables must have a value set to be detected. For example, `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. * `HOMEBREW_ARTIFACT_DOMAIN`: @@ -180,22 +181,16 @@ Note that environment variables must have a value set to be detected. For exampl editors will do strange things in this case. * `HOMEBREW_FORCE_BREWED_CURL`: - If set, Homebrew will use a Homebrew-installed `curl` rather than the - system version. + If set, Homebrew will always use a Homebrew-installed `curl` rather than the + system version. Automatically set if the system version of `curl` is too old. * `HOMEBREW_FORCE_VENDOR_RUBY`: If set, Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough. - * `HOMEBREW_GIT`: - When using Git, Homebrew will use `GIT` if set, - a Homebrew-built Git if installed, or the system-provided binary. - - Set this to force Homebrew to use a particular git binary. - * `HOMEBREW_FORCE_BREWED_GIT`: - If set, Homebrew will use a Homebrew-installed `git` rather than the - system version. + If set, Homebrew will always use a Homebrew-installed `git` rather than the + system version. Automatically set if the system version of `git` is too old. * `HOMEBREW_GITHUB_API_TOKEN`: A personal access token for the GitHub API, which you can create at diff --git a/Library/Homebrew/shims/scm/git b/Library/Homebrew/shims/scm/git index 0930c0adc3..c4e7ec5134 100755 --- a/Library/Homebrew/shims/scm/git +++ b/Library/Homebrew/shims/scm/git @@ -1,6 +1,6 @@ #!/bin/bash -# This script because we support $GIT, $HOMEBREW_SVN, etc., Xcode-only and +# This script because we support $HOMEBREW_GIT, $HOMEBREW_SVN, etc., Xcode-only and # no Xcode/CLT configurations. Order is careful to be what the user would want. set +o posix diff --git a/docs/Manpage.md b/docs/Manpage.md index 0dad55baa5..b7c0754964 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -1,5 +1,5 @@ brew(1) -- The missing package manager for macOS -=============================================== +================================================ ## SYNOPSIS @@ -1100,6 +1100,7 @@ can take several different forms: The formula file will be cached for later use. ## ENVIRONMENT + Note that environment variables must have a value set to be detected. For example, `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. * `HOMEBREW_ARTIFACT_DOMAIN`: @@ -1175,22 +1176,16 @@ Note that environment variables must have a value set to be detected. For exampl editors will do strange things in this case. * `HOMEBREW_FORCE_BREWED_CURL`: - If set, Homebrew will use a Homebrew-installed `curl` rather than the - system version. + If set, Homebrew will always use a Homebrew-installed `curl` rather than the + system version. Automatically set if the system version of `curl` is too old. * `HOMEBREW_FORCE_VENDOR_RUBY`: If set, Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough. - * `HOMEBREW_GIT`: - When using Git, Homebrew will use `GIT` if set, - a Homebrew-built Git if installed, or the system-provided binary. - - Set this to force Homebrew to use a particular git binary. - * `HOMEBREW_FORCE_BREWED_GIT`: - If set, Homebrew will use a Homebrew-installed `git` rather than the - system version. + If set, Homebrew will always use a Homebrew-installed `git` rather than the + system version. Automatically set if the system version of `git` is too old. * `HOMEBREW_GITHUB_API_TOKEN`: A personal access token for the GitHub API, which you can create at diff --git a/manpages/brew.1 b/manpages/brew.1 index 4480c25ecd..95cccd299a 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -1297,22 +1297,15 @@ If set, Homebrew will use this editor when editing a single formula, or several . .TP \fBHOMEBREW_FORCE_BREWED_CURL\fR -If set, Homebrew will use a Homebrew\-installed \fBcurl\fR rather than the system version\. +If set, Homebrew will always use a Homebrew\-installed \fBcurl\fR rather than the system version\. Automatically set if the system version of \fBcurl\fR is too old\. . .TP \fBHOMEBREW_FORCE_VENDOR_RUBY\fR If set, Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough\. . .TP -\fBHOMEBREW_GIT\fR -When using Git, Homebrew will use \fBGIT\fR if set, a Homebrew\-built Git if installed, or the system\-provided binary\. -. -.IP -Set this to force Homebrew to use a particular git binary\. -. -.TP \fBHOMEBREW_FORCE_BREWED_GIT\fR -If set, Homebrew will use a Homebrew\-installed \fBgit\fR rather than the system version\. +If set, Homebrew will always use a Homebrew\-installed \fBgit\fR rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\. . .TP \fBHOMEBREW_GITHUB_API_TOKEN\fR