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

3 files changed, 16 insertions, 9 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"   ||