admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
8,910 Commits 15 Branches 471 Tags
Commit Graph

18 Commits

Author SHA1 Message Date
Misty De Meo
d1440e504e Update manpage to remove cleanup --force 2016-01-18 10:14:56 -08:00
Martin Afanasjew
53e1ba3274 manpage: document '--dry-run' for 'prune' command 2016-01-06 08:18:59 +01:00
Martin Afanasjew
8161595015 manpage: add parentheses in 'search' synopsis 
For consistency with other commands where there is a list of mutually
exclusive options of which exactly one has to be specified.
 2016-01-06 08:18:04 +01:00
Martin Afanasjew
b3627cc5b2 manpage: fix minor formatting inconsistencies 2016-01-06 08:17:29 +01:00
Martin Afanasjew
aaefcb02b6 manpage: improve synopsis for 'options' command 
The options `--all`, `--installed`, and a list of formulae are mutually
exclusive arguments, of which exactly one is required.
 2016-01-06 08:17:17 +01:00
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
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