From 812ba7ea59ea0c3143a3aa30c7fd1791ce7e8965 Mon Sep 17 00:00:00 2001 From: Jonathan Chang Date: Tue, 14 Aug 2018 00:56:26 -0400 Subject: [PATCH] Update manpages about artifact/bottle variables --- Library/Homebrew/manpages/brew.1.md.erb | 10 ++++++++-- docs/Manpage.md | 10 ++++++++-- manpages/brew.1 | 4 ++-- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 9fb5444bec..04804651e8 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -105,7 +105,10 @@ can take several different forms: 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`: - If set, instructs Homebrew to use the given URL as a download mirror for bottles and binaries. + If set, instructs Homebrew to prefix all download URLs, including those + for bottles, with this variable. For example, a formula with a URL of + `https://example.com/foo.tar.gz` but `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` + would instead download from `http://localhost:8080/example.com/foo.tar.gz`. * `HOMEBREW_AUTO_UPDATE_SECS`: If set, Homebrew will only check for autoupdates once per this seconds interval. @@ -121,7 +124,10 @@ Note that environment variables must have a value set to be detected. For exampl (unsigned) URL. * `HOMEBREW_BOTTLE_DOMAIN`: - If set, instructs Homebrew to use the given URL as a download mirror for bottles. + By default, Homebrew uses `https://homebrew.bintray.com/` as its download + mirror for bottles. If set, instructs Homebrew to instead use the given + URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will + cause all bottles to download from the prefix `http://localhost:8080/`. * `HOMEBREW_BROWSER`: If set, uses this setting as the browser when opening project homepages, diff --git a/docs/Manpage.md b/docs/Manpage.md index 71271e1bc2..6d0d1c837a 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -1108,7 +1108,10 @@ can take several different forms: 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`: - If set, instructs Homebrew to use the given URL as a download mirror for bottles and binaries. + If set, instructs Homebrew to prefix all download URLs, including those + for bottles, with this variable. For example, a formula with a URL of + `https://example.com/foo.tar.gz` but `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` + would instead download from `http://localhost:8080/example.com/foo.tar.gz`. * `HOMEBREW_AUTO_UPDATE_SECS`: If set, Homebrew will only check for autoupdates once per this seconds interval. @@ -1124,7 +1127,10 @@ Note that environment variables must have a value set to be detected. For exampl (unsigned) URL. * `HOMEBREW_BOTTLE_DOMAIN`: - If set, instructs Homebrew to use the given URL as a download mirror for bottles. + By default, Homebrew uses `https://homebrew.bintray.com/` as its download + mirror for bottles. If set, instructs Homebrew to instead use the given + URL. For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will + cause all bottles to download from the prefix `http://localhost:8080/`. * `HOMEBREW_BROWSER`: If set, uses this setting as the browser when opening project homepages, diff --git a/manpages/brew.1 b/manpages/brew.1 index 9ace50a435..28e12b6011 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -1051,7 +1051,7 @@ Note that environment variables must have a value set to be detected\. For examp . .TP \fBHOMEBREW_ARTIFACT_DOMAIN\fR -If set, instructs Homebrew to use the given URL as a download mirror for bottles and binaries\. +If set, instructs Homebrew to prefix all download URLs, including those for bottles, with this variable\. For example, a formula with a URL of \fBhttps://example\.com/foo\.tar\.gz\fR but \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fR would instead download from \fBhttp://localhost:8080/example\.com/foo\.tar\.gz\fR\. . .TP \fBHOMEBREW_AUTO_UPDATE_SECS\fR @@ -1066,7 +1066,7 @@ When using the \fBS3\fR download strategy, Homebrew will look in these variables . .TP \fBHOMEBREW_BOTTLE_DOMAIN\fR -If set, instructs Homebrew to use the given URL as a download mirror for bottles\. +By default, Homebrew uses \fBhttps://homebrew\.bintray\.com/\fR as its download mirror for bottles\. If set, instructs Homebrew to instead use the given URL\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\. . .TP \fBHOMEBREW_BROWSER\fR