212 Commits

Author SHA1 Message Date
Zhiming Wang
c63400d56b analytics: relocate UUID to homebrew.analyticsuuid in .git/config
This way analytics related settings and parameters (currently
analyticsdisabled, analyticsmessage and analyticsuuid) are all kept in
the same place.

Note that in this commit we offer a path of migration: if
~/.homebrew_analytics_user_uuid already exists, read the UUID from it,
write to homebrew.analyticsuuid, and remove it.

See more detailed discussions in #145.

Closes #162.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-30 22:40:55 +02:00
Eitot
4333bce850 Clarify opt-out commands
* Clarify opt-out commands

* Partially rewrite opt-out paragraph
2016-04-27 14:49:09 -05:00
Christian Moritz
bc98fd3788 Language::Node.npm_install_args: add helper method (#37)
* add Language::Node helper module

This adds a language module for Node module based formulas.
It contains the 2 public methods `std_npm_install_args(libexec)` and
`local_npm_install_args`:

* `std_npm_install_args` is intended to be used in formulas for
  standard node modules and returns `npm install` args for a global
  style module installation to libexec.
* `local_npm_install_args` is for formulas, in which the `npm install`
  step is only one of multiple parts of the installation process and
  returns `npm install` args for a default local installation in place.

Both methods have in common, that they are

* making sure that a working copy of npm and node-gyp from node's
  libexec is prepended to the PATH (to not rely of a user managed npm)
* seting the npm cache to HOMEBREW_CACHE/npm, which fixes issues caused
  by overriding $HOME resulting in long install times + high disk usage
  (see https://github.com/Homebrew/brew/pull/37#issuecomment-208840366)

* audit: update npm install check for Language::Node

* cleanup: remove npm_cache too

* doc: add Node-for-Formula-Authors.md
2016-04-27 17:08:44 +01:00
Andrew Janke
be336159fb doco: add Prose Guidelines (WIP)
Closes #128.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-25 23:10:10 -04:00
Zev Eisenberg
0c95c60511 doco: analytics: fix typo
Closes #150.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-25 21:12:23 -04:00
Milkey Mouse
822ea6057b Fix a minor typo
Closes #149.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-25 20:40:33 -04:00
Mike McQuaid
df489cfde2 More analytics tweaks.
Provide a single command that can be run to disable analytics, run it if
`HOMEBREW_NO_ANALYTICS` is ever set and remove the user UUID file in
that case too.

References https://github.com/Homebrew/brew/issues/142.
2016-04-25 18:51:00 -05:00
Mike McQuaid
421cd5365f Point to analytics documentation on brew update.
Make sure that users are notified on the first run of `brew update`
after we enabled analytics about how it works and how to opt-out. This
will be shown to all users who have not already seen this message from
`brew update` or through a new Homebrew installation.

References https://github.com/Homebrew/install/pull/42
References https://github.com/Homebrew/brew/issues/142
2016-04-25 18:05:30 -05:00
Mike McQuaid
1451553188 Ship analytics for Homebrew.
For more information and opt-out instructions please read:
https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics
2016-04-23 14:27:09 +01:00
Mike McQuaid
2921795668 update: rebase (rather than merge) by default.
We want to always avoid merge commits being committed to Homebrew so
this feels like a better fit.
2016-04-22 10:06:59 +01:00
Mike McQuaid
341b64cc96 Formula-Cookbook: better inreplace example.
Make multiple replacements if using the block form.
2016-04-22 09:58:40 +01:00
Andrew Janke
4d35dd3fbb doco: "How to PR": do audit while revised formula is installed
Reorders the PR submission steps so `brew audit` is done after `brew install`,
so it can pick up issues with the installed formula, like non-executable stuff
in `bin/`. Matches the `test-bot` process better.

Minor style changes, including consistently using periods at the end of list items
which are complete imperative sentences.

Closes #127.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-21 15:22:34 -04:00
Andrew Janke
a3b70d38a7 brew-audit: pull style checks in to main audit output
This collects all violations for each formula in a single place, instead
of doing `brew style` outputs for all formulae first, and then the other
audit checks.

Closes #112.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-21 14:45:33 -04:00
Martin Afanasjew
312fdaa892 --version: move help to documentation comment
This implies that `--version` is treated in most places like a regular
command, e.g. being suggested in shell completion. Also fix the help
text that claimed output goes to standard error, while it actually goes
to standard output.
2016-04-20 13:45:26 +02:00
Andrew Janke
acc9a7ca85 brew test, install, update-test: add --keep-tmp option
Also enables sandbox for --interactive and --debug use of install
and test, using automatic retention.

Closes #66.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-18 12:23:08 -04:00
Xu Cheng
df79659045 update manpage for deps/uses 2016-04-16 21:47:47 +08:00
Chayoung You
e0264302c7 doc: remove outdated documentation for completion (#99)
By the commit edf000e4cd30c3626ccc28c52ed32f2d84a200dd, bash and zsh
completion scripts have been moved to `etc/bash_completion.d/brew` and
`share/zsh/site-functions/_brew`, respectively. Now completion will be
done automatically without any trick.
2016-04-16 21:12:28 +08:00
Mike McQuaid
f6d5ae2253 analytics: add more documentation, Linuxbrew ID. (#98) 2016-04-16 11:39:57 +01:00
Mike McQuaid
4e8c6e633c Document disabling of opt-in Homebrew analytics. (#79) 2016-04-12 12:17:56 +01:00
Mike McQuaid
0c85113053 Homebrew (opt-in) Analytics tweaks. (#57)
- add `HOMEBREW_PRODUCT` global variable
- only differentiate between `/usr/local` and `non-/usr/local` Homebrew
  prefixes to avoid sharing sensitive user information
- note if e.g. build errors are occurring under CI
- Add `HOMEBREW_NO_ANALYTICS` variable (this will be how people opt-out
  when this is enabled for everyone)
- Add `HOMEBREW_ANALYTICS_DEBUG` variable to output all the analytics
  that are sent
- Move Bash analytics code to `Library/Homebrew/utils/analytics.sh`
- Add documentation for our analytics and why/what/when/how and opt-out
- Only official Homebrew commands are reported
- Ruby analytics are now reported in a forked, background process
2016-04-12 11:02:22 +01:00
Andrew Janke
496fff643f doco: more updates for core/formula separation
Closes #71.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-11 19:29:42 -04:00
Max Nordlund
10edfcd218 Fix documentation error
Closes #10.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-10 22:59:25 +02:00
Max Nordlund
c8a2cd4e10 Generate the new man page 2016-04-10 22:59:25 +02:00
Dominyk Tiller
32ae71b256 xcode: expect 7.3 on 10.11
xcode: expect 7.3 on 10.11
2016-04-10 20:00:11 +01:00
Tim D. Smith
116075dda9 Remove advice on bad Python linking
This is pathological and something that should be fixed in core, not by
working around it.

Closes https://github.com/Homebrew/legacy-homebrew/pull/45704.
2016-04-09 18:21:05 -07:00
Martin Afanasjew
ea38a70395 prune: handle broken app symlinks
Remove broken symlinks from `/Applications` and `~/Applications` that
were previously created by `brew linkapps`, but are no longer valid
because formulae were uninstalled or the provided apps have changed.
2016-04-06 10:31:54 +02:00
Martin Afanasjew
b50e950f0e unlinkapps: add --dry-run option
Add `--dry-run` option as is customary for destructive commands. Update
`bash` completion and man page accordingly. Also correct and update
documentation for both `brew linkapps` and `brew unlinkapps` in more
general terms.
2016-04-06 10:31:54 +02:00
ilovezfs
fad235d8e8 tap: support --full even if installed
Makes `tap` re-runnable and unshallows when requested with `--full`.
Tapping with a different URL raises an exception.

The homebrew/core tap cannot be untapped with `untap` so running
`brew tap --full homebrew/core` is now a built-in way to get a full
clone of this tap without resorting to workarounds.

Closes #17.

Signed-off-by: ilovezfs <ilovezfs@icloud.com>
2016-04-05 07:25:27 -07:00
Mike McQuaid
276a797d37 Update documentation after repository split. 2016-04-03 14:03:33 +01:00
Xu Cheng
e72ea94824 doc: update for core/formula separation
Closes Homebrew/homebrew#50632.

Signed-off-by: Xu Cheng <xucheng@me.com>
2016-04-02 21:51:36 +08:00
Carol (Nichols || Goulding)
eda70673ea Fix backticks to prevent missing rendered text
The backticks being where they were, or not, caused text like
`<formula>` to not be shown when viewing the rendered text in a browser.

Closes Homebrew/homebrew#50428.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2016-03-26 14:50:10 +08:00
Chris Bracco
7f77adffd3 share/doc/homebrew/README: fix supporters link.
The link to the Kickstarter Supporters file was broken. This new link
points to the ./Kickstarter-Supporters.md file.

Closes Homebrew/homebrew#50335.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-03-26 14:50:10 +08:00
Xu Cheng
b8a4677de0 --repository: support to show tap path
This can become handy when we separate core code and formulae. For
example, we could use `cd $(brew --repo homebrew/core)` to go to core
tap path.

Closes Homebrew/homebrew#50346.

Signed-off-by: Xu Cheng <xucheng@me.com>
2016-03-24 14:52:13 +08:00
Dominyk Tiller
773451f027 keg_only external builds documentation: cleanup 2016-03-24 14:52:13 +08:00
Dominyk Tiller
760c596a8e Checksum_Deprecation: add guiding document
Closes Homebrew/homebrew#50282.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-03-23 13:41:16 +08:00
Baptiste Fontaine
f30221c7e1 Tips & Tricks: remove obsolete ref to SHA1 2016-03-20 13:48:18 +08:00
Alex Dunn
4516375db4 Formula Cookbook: /environmental/environment/
Closes Homebrew/homebrew#50146.

Signed-off-by: Alex Dunn <adunn@ucsb.edu>
2016-03-19 19:14:50 +08:00
Alex Dunn
90246be60a Formula Cookbook: note $HOME override
See https://github.com/Homebrew/homebrew/pull/50130#discussion_r56254860
2016-03-19 19:14:50 +08:00
Damien Pollet
57a81f9e22 Clarify case conventions in formula naming
If a formula's class name contains an uppercase-spelled acronym, the
messages given by `brew install` can be pretty confusing (it recommends
a formula named exactly the same…)

Closes Homebrew/homebrew#49639.

Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-03-01 22:12:29 -08:00
George Hartzell
76767f3d6e Formula-Cookbook: Improve testing suggestions
Based on recent feedback on some pull requests, I touched up the section about adding tests to formula.
I wanted to make it clearer that the examples demonstrate how to create files on the fly and add a pointer to the tinyxml2 formula (DomT4 pointed it out to me as a good example).

Closes Homebrew/homebrew#49641.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-29 16:30:23 +00:00
Mike McQuaid
8156e76576 Move Kickstarter supporters file. 2016-02-18 08:21:20 +00:00
Dominyk Tiller
3b0e89c43d FAQ: minor tweaks
Closes Homebrew/homebrew#49281.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-18 08:19:17 +00:00
Dominyk Tiller
6e33ace71b Formula-Cookbook: update CONTRIBUTING path 2016-02-18 08:19:17 +00:00
Dominyk Tiller
e9a9c8a73b doc/homebrew/FAQ: update CONTRIBUTING path 2016-02-18 08:19:17 +00:00
Dominyk Tiller
be79583b4e doc/homebrew/README: update CONTRIBUTING path 2016-02-18 08:19:17 +00:00
Dominyk Tiller
4a289a65d4 Troubleshooting: remove dead link 2016-02-18 05:07:25 +00:00
Dominyk Tiller
9b2765c04f El_Capitan_and_Homebrew: remove document
We haven't seen this for a fair while since Apple pushed further updates to the
SIP mechanism and believe it to be far less of an issue than it was previously.

If you encounter further failure, please file an Issue and we'll be happy to
help! At the moment though this advice is making people think there _will_ be an
issue at some point, which isn't generally proving the case.
2016-02-17 18:55:41 +00:00
Dominyk Tiller
326cc5c438 doc/xcode: update for 7.2.1
Closes Homebrew/homebrew#48955.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-07 21:26:57 +00:00
Kazem Keshavarz
e945461212 Tips-N'-Tricks: fix symlink for zsh completion
From `Library/Contributions/brew_zsh_completion.zsh`:

````bash
````

Then it should give symlinked file name of `_brew` instead of being just `brew_zsh_completion.zsh`

Closes Homebrew/homebrew#48897.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-07 04:01:47 +00:00
Joshua Jabbour
0d094ac8ef FAQ: fix brew pull GitHub link.
Closes Homebrew/homebrew#48794.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-03 21:10:34 +00:00