241 Commits

Author SHA1 Message Date
Mike McQuaid
0302a6bc7c audit: add --new-formula option.
Rather than nudge people to run `--strict` and then ignore some of the
results sometimes (e.g. GitHub repository notability) instead add a
dedicated `--new-formula` option that implies this is a one-time
advisory check.
2016-08-02 12:44:41 +01:00
Tim D. Smith
9f6cb8ed04 Document virtualenv support for Python apps
Closes #344.

Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-07-26 21:34:06 -07:00
Nathan Henrie
1455aa3da6 Fix spelling of penryn (#580)
penryn was misspelled, which led to me doing a fruitless code search for where the architecture stuff is set.
2016-07-24 20:11:42 -04:00
Mike McQuaid
91d32e77ad Deprecate homebrew/binary. (#512)
We're moving more stuff to Homebrew Cask which is better maintained and run.
2016-07-15 22:05:03 +01:00
jainish shah
48a1e1b47f Add HOMEBREW_ARTIFACT_DOMAIN option.
If set, this environment variable instructs Homebrew to use the given URL as a
download mirror (e.g. an Artifactory instance) for bottles and binaries.

Closes #387.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-07-13 11:45:15 +01:00
Martin Afanasjew
cf3806e747 tap-info: expand and correct help text 2016-07-10 23:20:56 +02:00
Martin Afanasjew
037729351f Regenerate man page to pick up recent changes
Amend 468ebc5ed540c77dea4772a35678b5b2575ac4ed by regenerating the
man page and its HTML version according to the changes in #443.
2016-07-04 15:17:22 +02:00
Zhiming Wang
cb711a2d39 create: add --tap option (#389)
This commit adds a --tap option to the create command such that a user
could create a formula in a specified tap instead of the core.
2016-06-24 08:23:41 +02:00
Viktor Szakats
6bd24a7fb8 audit.rb: require https for ftpmirror.gnu.org (#393)
* audit.rb: require https for ftpmirror.gnu.org

The situation is similar to other mirror redirectors: the server
may subsequently redirect to an insecure url. But it's a step.

* manpage: update HOMEBREW_NO_INSECURE_REDIRECT section
2016-06-22 18:56:10 +01:00
Xu Cheng
8f75706a04
manpage: update maintainers list
Closes #362.

Signed-off-by: Xu Cheng <xucheng@me.com>
2016-06-14 21:22:08 +08:00
Luca Favatella
d363ae53c0 doc/External-Commands: update default HOMEBREW_CACHE (#316) 2016-06-04 17:23:03 +01:00
Alexey Palazhchenko
e760c8bbca How-To-Open-a-Homebrew-Pull-Request: do not install bottle for test (#315) 2016-06-03 13:11:17 +01:00
Mike McQuaid
a9abbab917 Move HOMEBREW_CACHE to ~/Library/Caches (#292)
* cleanup: accept cache as an argument.

* config: move default HOMEBREW_CACHE to ~/Library.

* brew.1: document new default Homebrew cache.

* update-report: migrate legacy Homebrew cache.
2016-06-01 08:46:33 +01:00
Mike McQuaid
7dad182ed1 Bottle: remove local installation instructions.
These aren't targeted at end users.
2016-05-30 19:32:33 +01:00
Dominyk Tiller
a112627888
man: changes for 75ab94c 2016-05-30 17:06:23 +01:00
Martin Afanasjew
1c581a232c search: add alias -S back to zero-argument help
Amends 132ada2b0ebb3751c0f8f42ca83bb257b55a50fd until we properly figure
out a way of documenting built-in aliases (or not doing that) across all
commands that currently have aliases. See #270 for full discussion.
2016-05-26 17:52:58 +02:00
Joe Gallo
132ada2b0e Clarify brew search usage. (#270)
* Include --desc in brew search help text.
* Update brew search --desc text in README.
* Remove mention of alias in brew search help text to avoid any
  confusion.
2016-05-26 16:45:25 +02:00
Zhiming Wang
bc1d5ae4d4 install: fix documentation of --keep-tmp option (#258)
Obvious copy/paste failure in acc9a7ca8554bc2413dee2d6d0f407b3a59c628c.
2016-05-19 08:43:42 +02:00
Andrew Janke
63ea9295cf brew audit: add --display-filename format option for easy grepping (#221) 2016-05-11 09:19:45 -07:00
Martin Afanasjew
5a90e7190b fetch: document --retry option (#225) 2016-05-09 15:37:01 +02:00
Jam
a558629654 gist-logs: add proper documentation, improve error handling (#217) 2016-05-09 04:39:22 +02:00
Martin Afanasjew
815edc0686 Update man page to pick up changes made in #205.
Seems like last-minute changes were made without re-running `brew man`.
2016-05-09 01:33:19 +02:00
Andrew Janke
d887dd39ec brew install: make -s apply only to given formula, not deps (#205) 2016-05-06 12:02:13 -07:00
Martin Afanasjew
c55da93ff3 xcode: expect 7.3.1 on 10.11 2016-05-05 12:22:37 +01:00
Mike McQuaid
9a9a989b75 Analytics: remove cask. 2016-05-04 17:52:15 +01:00
Martin Afanasjew
6fdcab5abc deps: split and clarify documentation
`brew deps` has three different modes of operation that were not easy to
infer from the existing documentation. Split the help text into three
parts to make this clearer. This also improves on the confusion when
options were silently ignored because they don't apply to a certain mode
of operation. Those are:

1. List the shared dependencies (either intersection or union) of
   explicitly named formulae with options for traversal depth/order.

2. Output separate trees of explicitly listed or all installed formulae.

3. List all available/installed formulae and their direct dependencies
   with one line per formula formatted as `<formula>: <dependencies>`.

Closes #137.

Closes #179.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-05-03 17:19:18 +02:00
Mike McQuaid
489a1d8f43 Add "Maintainers: Avoiding Burnout" document. 2016-05-03 14:23:42 +01:00
Martin Afanasjew
8284fb3fef Update Homebrew/homebrew references in man page
Replace `homebrew` with `brew`, `homebrew-core`, or `legacy-homebrew`
depending on context.

Closes #175.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-05-02 21:19:09 +02:00
Xu Cheng
98aff27317 add brew analytics command (#173) 2016-05-01 22:04:46 +08:00
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