diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Acceptable-Formulae.md | 3 | ||||
| -rw-r--r-- | docs/Analytics.md | 4 | ||||
| -rw-r--r-- | docs/Manpage.md | 9 | ||||
| -rw-r--r-- | docs/Python-for-Formula-Authors.md | 14 | ||||
| -rw-r--r-- | docs/Xcode.md | 3 | 
5 files changed, 12 insertions, 21 deletions
| diff --git a/docs/Acceptable-Formulae.md b/docs/Acceptable-Formulae.md index d59129ecc..0773d12d9 100644 --- a/docs/Acceptable-Formulae.md +++ b/docs/Acceptable-Formulae.md @@ -40,9 +40,6 @@ There are exceptions:  | openssl            | macOS's openssl is deprecated & outdated                                                              |  | libxml2            | Historically, macOS's libxml2 has been buggy                                                          | -We also maintain [a tap](https://github.com/Homebrew/homebrew-dupes) that -contains many duplicates not otherwise found in Homebrew. -  ### We donβt like tools that upgrade themselves  Software that can upgrade itself does not integrate well with Homebrew's own  upgrade functionality. diff --git a/docs/Analytics.md b/docs/Analytics.md index 69ab0b58f..15fa6fc93 100644 --- a/docs/Analytics.md +++ b/docs/Analytics.md @@ -18,14 +18,12 @@ Homebrew's analytics record some shared information for every event:  - If the Google Analytics anonymous IP setting is enabled, i.e. `1` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#aip)  - The Homebrew application name, e.g. `Homebrew` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#an)  - The Homebrew application version, e.g. `0.9.9` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#av) -- The Homebrew analytics hit type, e.g. `screenview` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#t) +- The Homebrew analytics hit type, e.g. `event` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#t)  Homebrew's analytics records the following different events: -- a `screenview` hit type with the official Homebrew command you have run (with arguments stripped), e.g. `brew list` (not `brew list foo` or any external commands except `bundle` and `services`)  - an `event` hit type with the `install` event category and the Homebrew formula from a non-private GitHub tap you have requested to install plus any used options, e.g. `wget --with-pcre` as the action and an event label e.g. `macOS 10.12, non-/usr/local, CI` to indicate the OS version, non-standard installation location and invocation as part of CI. This allows us to identify the formulae that need fixing and where more easily.  - an `event` hit type with the `BuildError` event category and the Homebrew formula that failed to install, e.g. `wget` as the action and an event label e.g. `macOS 10.12` -- an `exception` hit type with the `exception` event category and exception description of the exception name, e.g. `FormulaUnavailableError` and whether the exception was fatal e.g. `1`  You can also view all the information that is sent by Homebrew's analytics by setting `HOMEBREW_ANALYTICS_DEBUG=1` in your environment. Please note this will also stop any analytics from being sent. diff --git a/docs/Manpage.md b/docs/Manpage.md index 523eaf289..b679bd581 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -599,8 +599,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note      Display the location in the cellar where `formula` is or would be installed.    * `--repository`: -    Display where Homebrew's `.git` directory is located. For standard installs, -    the `prefix` and `repository` are the same directory. +    Display where Homebrew's `.git` directory is located.    * `--repository` `user``/``repo`:      Display where tap `user``/``repo`'s directory is located. @@ -845,10 +844,8 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note      If `--no-compat` is passed, do not load the compatibility layer when      running tests. -    If `--online` is passed, include tests that use the GitHub API. - -    If `--official-cmd-taps` is passed, include tests that use any of the -    taps for official external commands. +    If `--online` is passed, include tests that use the GitHub API and tests +    that use any of the taps for official external commands.    * `update-test` [`--commit=``commit`] [`--before=``date`] [`--to-tag`] [`--keep-tmp`]:      Runs a test of `brew update` with a new repository clone. diff --git a/docs/Python-for-Formula-Authors.md b/docs/Python-for-Formula-Authors.md index ea86cf84c..8b4bc2cb4 100644 --- a/docs/Python-for-Formula-Authors.md +++ b/docs/Python-for-Formula-Authors.md @@ -98,14 +98,12 @@ def install    venv = virtualenv_create(libexec)    # Install all of the resources declared on the formula into the virtualenv.    venv.pip_install resources -  # `link_scripts` takes a look at the virtualenv's bin directory before and -  # after executing the block which is passed into it. If the block caused any -  # new scripts to be written to the virtualenv's bin directory, link_scripts -  # will symlink those scripts into the path given as its argument (here, the -  # formula's `bin` directory in the Cellar.) -  # `pip_install buildpath` will install the package that the formula points to, -  # because buildpath is the location where the formula's tarball was unpacked. -  venv.link_scripts(bin) { venv.pip_install buildpath } +  # `pip_install_and_link` takes a look at the virtualenv's bin directory +  # before and after installing its argument. New scripts will be symlinked +  # into `bin`. `pip_install_and_link buildpath` will install the package +  # that the formula points to, because buildpath is the location where the +  # formula's tarball was unpacked. +  venv.pip_install_and_link buildpath  end  ``` diff --git a/docs/Xcode.md b/docs/Xcode.md index 7c2cca5c8..21ad66f95 100644 --- a/docs/Xcode.md +++ b/docs/Xcode.md @@ -12,7 +12,7 @@ Tools available for your platform:  | 10.9  | 6.2   | 6.2                |  | 10.10 | 7.2.1 | 7.2                |  | 10.11 | 8.2.1 | 8.2                | -| 10.12 | 8.3.2 | 8.3                | +| 10.12 | 8.3.3 | 8.3                |  ## Compiler version database @@ -72,6 +72,7 @@ Tools available for your platform:  | 8.3   | β       | β       | β            | β          | 8.1 (802.0.38)  | β          |  | 8.3.1 | β       | β       | β            | β          | 8.1 (802.0.41)  | β          |  | 8.3.2 | β       | β       | β            | β          | 8.1 (802.0.42)  | β          | +| 8.3.3 | β       | β       | β            | β          | 8.1 (802.0.42)  | β          |  ## References to Xcode and compiler versions in code  When a new Xcode release is made, the following things need to be | 
