234 Commits

Author SHA1 Message Date
Martin Afanasjew
18bf5a74a8 cleanup: consistently document --dry-run option
All other commands document both `--dry-run` and `-n` in the option
description and mention only `--dry-run` in the command summary. Let's
do the same for `cleanup`.

Closes Homebrew/homebrew#46942.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2015-12-13 02:20:02 +01:00
Martin Afanasjew
85181a067f manpage: remove superfluous spaces for consistency
All other alternatives already don't use spaces around the pipe symbol.

Closes Homebrew/homebrew#46825.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2015-12-10 15:00:36 +01:00
Martin Afanasjew
8144f90eac manpage: fix formatting of command list
Restore definition list in `COMMANDS` section, thus massively improve
formatting. In theory, `ronn` supports nested (definition) lists. In
practice, this does not work (and is unlikely to be fixed soon because
upstream seems to be rather inactive) causing the entire definition list
to be longer recognized because of a single nested list. Work around by
rearranging the `tap` documentation (sole command with a nested list).
2015-12-10 15:00:36 +01:00
Andrew Janke
92a1fca6e4 manpages: minor markup fixes
Fixes a couple issues left behind by Homebrew/homebrew#46676.

Closes Homebrew/homebrew#46706.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-08 12:35:20 -05:00
Mike McQuaid
b745546943 Overhaul, simplify and cleanup documentation.
Remove duplication, link to the API documentation more often,
tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s
and `@adamv`'s significant past contributions to Homebrew, delete some
outdated or unneeded documentation, add some missing `Formula` API.
entries and simplify/improve `CONTRIBUTING.md`.

Closes Homebrew/homebrew#46179.

Closes Homebrew/homebrew#46618.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-07 13:37:49 +00:00
Andrew Janke
98fbcb7299 manpages: fix missing backtick 2015-12-05 10:23:16 -05:00
Andrew Janke
5230ed2117 man page: finer-grained markup
Closes Homebrew/homebrew#44769

Closes Homebrew/homebrew#46676.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-05 00:41:32 -05:00
Martin Afanasjew
18a743c470 manpage: synchronize maintainer list with README 2015-12-02 00:56:36 +01:00
Mike McQuaid
74e407dc54 The Formula API is no longer work-in-progress.
Feature it a bit more prominently in the documentation as a result.

Closes Homebrew/homebrew#45374.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-27 10:45:23 -06:00
Mike McQuaid
4cfdef65ed Update manpage. 2015-10-20 08:52:46 +01:00
Rakesh
2d60187e1a brew upgrade: provides an option --cleanup
Closes Homebrew/homebrew#44305.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-07 14:05:11 +08:00
Dan Martinez
8374374168 Improve description searching and add a cache.
Closes Homebrew/homebrew#42281.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-08 15:23:37 +01:00
Xu Cheng
5eab79e70f manpage: add unlink --dry-run 2015-09-06 15:37:47 +08:00
Mike McQuaid
2c959a7d58 More API documentation.
And remove the documented stuff from the `example-formula.rb`.

Closes Homebrew/homebrew#43241.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-29 15:43:16 +01:00
Xu Cheng
329358c33c manpage: add doc for tap --list-official and --list-pinned 2015-08-21 20:08:13 +08:00
Vlad Shablinsky
35ef2bc132 update manpages for migrate
Closes Homebrew/homebrew#42801.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-08-20 19:55:35 +08:00
Xu Cheng
502101a2e2 manpage: slight format tweak 2015-08-17 16:12:29 +08:00
Dominyk Tiller
fbfaa8a39a man: sha1 => sha256 reference
Closes Homebrew/homebrew#42507.
2015-08-11 20:36:13 +01:00
Xu Cheng
12e154a418 man: remove unnecessary --all in brew upgrade 2015-08-10 23:12:30 +08:00
Vlad Shablinsky
622a8502dc add manpages 2015-08-10 13:57:59 +01:00
CNA-Bld
77ee9bd446 update man page
Closes Homebrew/homebrew#41736.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-10 12:17:26 +01:00
Alex Dunn
b22d899d3a Add Alex Dunn as a maintainer.
Closes Homebrew/homebrew#42347.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-02 13:19:55 +01:00
Baptiste Fontaine
587ab81074 manpage: new maintainers added to the list
I kept the same order as in README.md.

Closes Homebrew/homebrew#41655.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-07-14 13:31:22 +02:00
Xu Cheng
a2d9d68591 commands: support list all commands without header 2015-07-11 00:07:29 +08:00
Mike McQuaid
3ac6005931 audit: add --online flag.
Also add it to the manpage and brew-test-bot.

Closes Homebrew/homebrew#41516.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-07-09 14:50:55 +01:00
Alex Dunn
8071dcac24 brew.1: document install --force-bottle
Closes Homebrew/homebrew#41398.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-07-08 02:43:32 +01:00
Xu Cheng
ab9a62370f support downloading bottles through 3rd-party mirror
Closes Homebrew/homebrew#41328.

Closes Homebrew/homebrew#41332.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-07-06 18:05:00 +08:00
Jack Nagel
690bf9b8b9 Remove myself from the maintainers list
It's been fun.
2015-07-04 23:04:02 -04:00
Xu Cheng
78a7dea3a0 add brew command
Closes Homebrew/homebrew#41034.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-07-03 14:22:38 +08:00
Dominyk Tiller
528144c6f2 Revert "man: update for Homebrew/homebrew#40985"
This reverts commit 2cdbc07dd0ed210ff631ba3a79365aff429c1906.

Apologies, I'm an idiot who can't read which files were changed properly.
2015-06-26 20:23:16 +01:00
Dominyk Tiller
820451a663 man: update for Homebrew/homebrew#40985 2015-06-26 20:22:14 +01:00
Wael M. Nasreddine
f916daea21 manpage: irb command take --examples options
Closes Homebrew/homebrew#40985.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-06-26 20:21:34 +01:00
Colin Dean
e12295849d Adds JSON output to outdated command
After some musing on brunophilipe/Cakebrew#71, I thought it would
be useful to let Cakebrew and other tools grab the outdated formulae
version information using a method more elegant than regex.

Closes Homebrew/homebrew#30693.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2015-06-25 19:32:23 -04:00
Xu Cheng
b18015a7e1 manpage: update list command
Closes Homebrew/homebrew#40921.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-06-22 22:17:10 +08:00
Dominyk Tiller
8350e9c5ad man: fix typo
Re: ad92f10ec3 (commitcomment-11670008)
2015-06-14 18:36:16 +01:00
Peter Aronoff
5e3a1a7b21 Update tap documentation.
Closes Homebrew/homebrew#40481.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-06-14 14:35:13 +01:00
Dominyk Tiller
696d7f3ba0 manpages: document new environmental variable
Closes Homebrew/homebrew#38835.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-06-14 13:20:07 +01:00
Xu Cheng
d8876a9da4 manpage: add tap-info 2015-06-11 15:28:30 +08:00
Larry Gilbert
69b629b041 Various edits for punctuation, grammar, spelling, etc.
Closes Homebrew/homebrew#40478.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-06-10 17:44:00 +01:00
Mike McQuaid
f4af833714 Revert "upgrade: announce usage of --all."
This reverts commit 9032f165bec3d0c7452169093fab32578816043b.

This seems to have been universally unpopular so let's revert it.

Closes Homebrew/homebrew#40372.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-06-05 14:20:21 +01:00
Xu Cheng
074de88a9b update manpage 2015-05-27 13:53:40 +08:00
Dominyk Tiller
13540f85ab man: regenerate man for Homebrew/homebrew#39447 2015-05-26 20:40:27 +01:00
Jack Nagel
b638c1d597 Use "directory", not "folder" 2015-05-14 00:15:41 -04:00
Shaun Jackman
e5f6264f32 brew.1.md: Document HOMEBREW_LOGS
Edit Library/Homebrew/manpages/brew.1.md
Regenerate share/man/man1/brew.1

Closes Homebrew/homebrew#39722.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2015-05-14 00:15:41 -04:00
Xu Cheng
fa9371e58e tap: support fast clone
Closes Homebrew/homebrew#37592.
Closes Homebrew/homebrew#38268.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-05-08 15:48:51 +08:00
Xu Cheng
417b1dffa5 manpage: fix brew upgrade sentence 2015-05-06 16:23:09 +08:00
Xu Cheng
1f7c4ee644 replace brew upgrade with brew upgrade --all. 2015-05-06 16:19:07 +08:00
Alex Muller
83bcde2317 Update links to GitHub's personal access token
The link for the page that allows creation of API tokens has changed
from /settings/applications to /settings/tokens. Also the wording
on that page calls them "personal access tokens", so update
Homebrew to be consistent with that.

Closes Homebrew/homebrew#39378.

Signed-off-by: Tim D. Smith <git@tim-smith.us>
2015-05-05 15:46:42 -07:00
Xu Cheng
ff34b1af3b manpage: add missing document
Closes Homebrew/homebrew#38351.
Closes Homebrew/homebrew#38960.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-04-27 12:00:04 +08:00
Mike McQuaid
c725059251 upgrade: announce usage of --all.
Tell users that we will soon be migrating `--all` so it is required if
you wish to upgrade all formulae.

Closes Homebrew/homebrew#38572.
2015-04-26 19:40:33 +01:00