Skip to content

Commit

Permalink
docs: move language reference to docs.brew.sh (Homebrew#104628)
Browse files Browse the repository at this point in the history
* doc: move language reference to docs.brew.sh

* doc: reference Cask Cookbook instead of language reference
  • Loading branch information
SMillerDev authored May 4, 2021
1 parent a90f74e commit 7be05ad
Show file tree
Hide file tree
Showing 36 changed files with 43 additions and 1,482 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ With a bit of work, you can create a Cask for it. The document [Adding A Cask](d
Some style guidelines:

* All Casks and code should be indented using two spaces (never tabs). When `brew style` contradicts this, `style` must be followed.
* There should not be any extraneous comments - the only comments that should be used are the ones explicitly defined in the [Cask Language Reference](doc/cask_language_reference).
* The stanza order and position of newlines is important to make things easier (See [Stanza order](doc/cask_language_reference/#stanza-order)).
* Use string manipulations to improve the maintainability of your Cask (See [`version` methods](doc/cask_language_reference/stanzas/version.md#version-methods)).
* There should not be any extraneous comments - the only comments that should be used are the ones explicitly defined in the [Cask Cookbook](https://docs.brew.sh/Cask-Cookbook.md).
* The stanza order and position of newlines is important to make things easier (See [Stanza order](https://docs.brew.sh/Cask-Cookbook.md#stanza-order)).
* Use string manipulations to improve the maintainability of your Cask (See [`version` methods](https://docs.brew.sh/Cask-Cookbook.md#version-methods)).
* Test your cask using `brew audit/style` (See [testing](doc/development/adding_a_cask.md#testing-your-new-cask)).
* Make one Pull Request per Cask change.
* Do not squash commits after updating a Pull Request.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If the issue is still not solved, see the guides for common problems:

## Requests

* Issues requesting new casks will be closed. If you want a cask added to the main repositories, [submit a pull request](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#adding-a-cask).
* Issues requesting new casks will be closed. If you want a cask added to the main repositories, [submit a pull request](https://github.com/Homebrew/homebrew-cask/blob/HEAD/CONTRIBUTING.md#adding-a-cask).
* For a feature request, [use this template](https://github.com/Homebrew/homebrew-cask/issues/new?template=02_feature_request.md).

## Questions? Wanna chat?
Expand Down
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ atom google-chrome 1password

With `--full-name` the Tap name will also be included, _e.g._: `purple/monkey/dishwasher` for the Cask `dishwasher` installed from the Tap `purple/monkey`.

Given an installed Cask, `brew list --casks {{cask_name}}` lists the staged files.
Given an installed Cask, `brew list --casks <cask_name>` lists the staged files.

Show details about a specific Cask:

Expand Down Expand Up @@ -155,7 +155,7 @@ $ brew install homebrew/cask-fonts/font-symbola
* `--debug`: output debug information
* `--no-binaries`: skip symlinking executable binaries into `/usr/local/bin`
* `--require-sha`: abort installation of Cask if no checksum is defined
* `--no-quarantine`: [disable Apple’s quarantining](https://github.com/Homebrew/homebrew-cask/blob/master/doc/faq/app_cant_be_opened.md) for the specific app
* `--no-quarantine`: [disable Apple’s quarantining](https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/faq/app_cant_be_opened.md) for the specific app
* `--language=<iso-language>[,<iso-language> ... ]`: changes the language of the Cask to be installed. The first matching language is used, otherwise it uses the default language of the Cask.

You can also modify the default installation locations used when issuing `brew install`:
Expand Down
62 changes: 0 additions & 62 deletions doc/cask_language_reference/all_stanzas.md

This file was deleted.

175 changes: 0 additions & 175 deletions doc/cask_language_reference/readme.md

This file was deleted.

Loading

0 comments on commit 7be05ad

Please sign in to comment.