Document disabling of opt-in Homebrew analytics. (#79)

5 files changed, 30 insertions, 13 deletions

diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md
index 38113ad88..575132336 100644
--- a/Library/Homebrew/manpages/brew.1.md
+++ b/Library/Homebrew/manpages/brew.1.md
@@ -36,7 +36,6 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
     If no search term is given, all locally available formulae are listed.
 
 ## COMMANDS
-
   * `audit` [`--strict`] [`--online`] [<formulae>]:
     Check <formulae> for Homebrew coding style violations. This should be
     run before submitting a new formula.
@@ -641,7 +640,7 @@ can take several different forms:
     If set, Homebrew will use this editor when editing a single formula, or
     several formulae in the same directory.
 
-    *NOTE*: `brew edit` will open all of Homebrew as discontinuous files and
+    *Note:* `brew edit` will open all of Homebrew as discontinuous files and
     directories. TextMate can handle this correctly in project mode, but many
     editors will do strange things in this case.
 
@@ -652,7 +651,7 @@ can take several different forms:
     <https://developer.github.com/v3/#rate-limiting> for more information.
     Homebrew uses the GitHub API for features such as `brew search`.
 
-    *NOTE*: Homebrew doesn't require permissions for any of the scopes.
+    *Note:* Homebrew doesn't require permissions for any of the scopes.
 
   * `HOMEBREW_LOGS`:
     If set, Homebrew will use the given directory to store log files.
@@ -663,6 +662,11 @@ can take several different forms:
 
     *Default:* the number of available CPU cores.
 
+  * `HOMEBREW_NO_ANALYTICS`:
+    If set, Homebrew will not send analytics. See: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics>
+
+    *Note:* Homebrew currently disables analytics by default.
+
   * `HOMEBREW_NO_EMOJI`:
     If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
     successful build.
diff --git a/Library/Homebrew/manpages/footer.1.md b/Library/Homebrew/manpages/footer.1.md
index 4d0eff262..5ff6656a7 100644
--- a/Library/Homebrew/manpages/footer.1.md
+++ b/Library/Homebrew/manpages/footer.1.md
@@ -127,7 +127,7 @@ can take several different forms:
     If set, Homebrew will use this editor when editing a single formula, or
     several formulae in the same directory.
 
-    *NOTE*: `brew edit` will open all of Homebrew as discontinuous files and
+    *Note:* `brew edit` will open all of Homebrew as discontinuous files and
     directories. TextMate can handle this correctly in project mode, but many
     editors will do strange things in this case.
 
@@ -138,7 +138,7 @@ can take several different forms:
     <https://developer.github.com/v3/#rate-limiting> for more information.
     Homebrew uses the GitHub API for features such as `brew search`.
 
-    *NOTE*: Homebrew doesn't require permissions for any of the scopes.
+    *Note:* Homebrew doesn't require permissions for any of the scopes.
 
   * `HOMEBREW_LOGS`:
     If set, Homebrew will use the given directory to store log files.
@@ -149,6 +149,11 @@ can take several different forms:
 
     *Default:* the number of available CPU cores.
 
+  * `HOMEBREW_NO_ANALYTICS`:
+    If set, Homebrew will not send analytics. See: <https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics>
+
+    *Note:* Homebrew currently disables analytics by default.
+
   * `HOMEBREW_NO_EMOJI`:
     If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
     successful build.
diff --git a/Library/Homebrew/utils/analytics.sh b/Library/Homebrew/utils/analytics.sh
index 015a62ab3..69d882eb9 100644
--- a/Library/Homebrew/utils/analytics.sh
+++ b/Library/Homebrew/utils/analytics.sh
@@ -17,10 +17,8 @@ setup-analytics() {
 }
 
 report-analytics-screenview-command() {
-  if [[ -z "$HOMEBREW_ANALYTICS" || -n "$HOMEBREW_NO_ANALYTICS" ]]
-  then
-    return
-  fi
+  [[ -z "$HOMEBREW_ANALYTICS" ]] && return
+  [[ -n "$HOMEBREW_NO_ANALYTICS" ]] && return
 
   # Don't report non-official commands.
   if ! [[ "$HOMEBREW_COMMAND" = "bundle"   ||
diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html
index 54090ac86..dc7f2a701 100644
--- a/share/doc/homebrew/brew.1.html
+++ b/share/doc/homebrew/brew.1.html
@@ -472,7 +472,7 @@ developers (active or budding).</p></dd>
 <dt><code>HOMEBREW_EDITOR</code></dt><dd><p>If set, Homebrew will use this editor when editing a single formula, or
 several formulae in the same directory.</p>
 
-<p><em>NOTE</em>: <code>brew edit</code> will open all of Homebrew as discontinuous files and
+<p><em>Note:</em> <code>brew edit</code> will open all of Homebrew as discontinuous files and
 directories. TextMate can handle this correctly in project mode, but many
 editors will do strange things in this case.</p></dd>
 <dt><code>HOMEBREW_GITHUB_API_TOKEN</code></dt><dd><p>A personal access token for the GitHub API, which you can create at
@@ -481,12 +481,15 @@ greater number of API requests. See
 <a href="https://developer.github.com/v3/#rate-limiting" data-bare-link="true">https://developer.github.com/v3/#rate-limiting</a> for more information.
 Homebrew uses the GitHub API for features such as <code>brew search</code>.</p>
 
-<p><em>NOTE</em>: Homebrew doesn't require permissions for any of the scopes.</p></dd>
+<p><em>Note:</em> Homebrew doesn't require permissions for any of the scopes.</p></dd>
 <dt><code>HOMEBREW_LOGS</code></dt><dd><p>If set, Homebrew will use the given directory to store log files.</p></dd>
 <dt><code>HOMEBREW_MAKE_JOBS</code></dt><dd><p>If set, instructs Homebrew to use the value of <code>HOMEBREW_MAKE_JOBS</code> as
 the number of parallel jobs to run when building with <code>make</code>(1).</p>
 
 <p><em>Default:</em> the number of available CPU cores.</p></dd>
+<dt><code>HOMEBREW_NO_ANALYTICS</code></dt><dd><p>If set, Homebrew will not send analytics. See: <a href="https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics" data-bare-link="true">https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics</a></p>
+
+<p><em>Note:</em> Homebrew currently disables analytics by default.</p></dd>
 <dt><code>HOMEBREW_NO_EMOJI</code></dt><dd><p>If set, Homebrew will not print the <code>HOMEBREW_INSTALL_BADGE</code> on a
 successful build.</p>
 
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index c7178459b..f51bafb9c 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -668,14 +668,14 @@ If set, Homebrew will print warnings that are only relevant to Homebrew develope
 If set, Homebrew will use this editor when editing a single formula, or several formulae in the same directory\.
 .
 .IP
-\fINOTE\fR: \fBbrew edit\fR will open all of Homebrew as discontinuous files and directories\. TextMate can handle this correctly in project mode, but many editors will do strange things in this case\.
+\fINote:\fR \fBbrew edit\fR will open all of Homebrew as discontinuous files and directories\. TextMate can handle this correctly in project mode, but many editors will do strange things in this case\.
 .
 .TP
 \fBHOMEBREW_GITHUB_API_TOKEN\fR
 A personal access token for the GitHub API, which you can create at \fIhttps://github\.com/settings/tokens\fR\. If set, GitHub will allow you a greater number of API requests\. See \fIhttps://developer\.github\.com/v3/#rate\-limiting\fR for more information\. Homebrew uses the GitHub API for features such as \fBbrew search\fR\.
 .
 .IP
-\fINOTE\fR: Homebrew doesn\'t require permissions for any of the scopes\.
+\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes\.
 .
 .TP
 \fBHOMEBREW_LOGS\fR
@@ -689,6 +689,13 @@ If set, instructs Homebrew to use the value of \fBHOMEBREW_MAKE_JOBS\fR as the n
 \fIDefault:\fR the number of available CPU cores\.
 .
 .TP
+\fBHOMEBREW_NO_ANALYTICS\fR
+If set, Homebrew will not send analytics\. See: \fIhttps://github\.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics\.md#analytics\fR
+.
+.IP
+\fINote:\fR Homebrew currently disables analytics by default\.
+.
+.TP
 \fBHOMEBREW_NO_EMOJI\fR
 If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
 .