admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

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

Browse Source
This commit is contained in:
Mike McQuaid 2016-04-12 12:17:56 +01:00
parent 548be81b34
commit 4e8c6e633c
5 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Library/Homebrew/manpages/brew.1.md
View File

@ -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. If no search term is given, all locally available formulae are listed.
## COMMANDS ## COMMANDS
* `audit` [`--strict`] [`--online`] [<formulae>]: * `audit` [`--strict`] [`--online`] [<formulae>]:
Check <formulae> for Homebrew coding style violations. This should be Check <formulae> for Homebrew coding style violations. This should be
run before submitting a new formula. 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 If set, Homebrew will use this editor when editing a single formula, or
several formulae in the same directory. 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 directories. TextMate can handle this correctly in project mode, but many
editors will do strange things in this case. 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. <https://developer.github.com/v3/#rate-limiting> for more information.
Homebrew uses the GitHub API for features such as `brew search`. 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`: * `HOMEBREW_LOGS`:
If set, Homebrew will use the given directory to store log files. 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. *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`: * `HOMEBREW_NO_EMOJI`:
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
successful build. successful build.

9
Library/Homebrew/manpages/footer.1.md
View File

@ -127,7 +127,7 @@ can take several different forms:
If set, Homebrew will use this editor when editing a single formula, or If set, Homebrew will use this editor when editing a single formula, or
several formulae in the same directory. 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 directories. TextMate can handle this correctly in project mode, but many
editors will do strange things in this case. 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. <https://developer.github.com/v3/#rate-limiting> for more information.
Homebrew uses the GitHub API for features such as `brew search`. 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`: * `HOMEBREW_LOGS`:
If set, Homebrew will use the given directory to store log files. 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. *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`: * `HOMEBREW_NO_EMOJI`:
If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a If set, Homebrew will not print the `HOMEBREW_INSTALL_BADGE` on a
successful build. successful build.

6
Library/Homebrew/utils/analytics.sh
View File

@ -17,10 +17,8 @@ setup-analytics() {
} }
report-analytics-screenview-command() { report-analytics-screenview-command() {
if [[ -z "$HOMEBREW_ANALYTICS" || -n "$HOMEBREW_NO_ANALYTICS" ]] [[ -z "$HOMEBREW_ANALYTICS" ]] && return
then [[ -n "$HOMEBREW_NO_ANALYTICS" ]] && return
return
fi
# Don't report non-official commands. # Don't report non-official commands.
if ! [[ "$HOMEBREW_COMMAND" = "bundle" || if ! [[ "$HOMEBREW_COMMAND" = "bundle" ||

7
share/doc/homebrew/brew.1.html
View File

@ -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 <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> 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 directories. TextMate can handle this correctly in project mode, but many
editors will do strange things in this case.</p></dd> 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 <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. <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> 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_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 <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> 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> <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 <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> successful build.</p>

11
share/man/man1/brew.1
View File

@ -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\. If set, Homebrew will use this editor when editing a single formula, or several formulae in the same directory\.
. .
.IP .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 .TP
\fBHOMEBREW_GITHUB_API_TOKEN\fR \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\. 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 .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 .TP
\fBHOMEBREW_LOGS\fR \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\. \fIDefault:\fR the number of available CPU cores\.
. .
.TP .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 \fBHOMEBREW_NO_EMOJI\fR
If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\. If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
. .