admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

docs: improve terminology guide from code review

Browse Source 
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
This commit is contained in:
Rylan Polster 2021-06-08 10:45:03 -04:00
parent 2c22a258a0
commit 45f23d4c16
No known key found for this signature in database
GPG Key ID: 46A744940CFF4D64
3 changed files with 47 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Library/Homebrew/manpages/brew.1.md.erb
View File

@ -30,21 +30,25 @@ Linux distribution to your home directory without requiring `sudo`.
## TERMINOLOGY ## TERMINOLOGY
**Formula**: The package definition **formula**: Homebrew package definition built from upstream sources
**Cask**: An extension of Homebrew to install macOS native apps **cask**: Homebrew package definition that installs macOS native applications
**Keg**: The installation prefix of a **Formula** **keg**: installation destination directory of a given **formula** version e.g. `/usr/local/Cellar/foo/0.1`
**Keg-only**: A **Formula** is **Keg-only** if it is not linked into the Homebrew prefix **rack**: directory containing one or more versioned kegs e.g. `/usr/local/Cellar/foo`
**Cellar**: All **Kegs** are installed here **keg-only**: a **formula** is **keg-only** if it is not symlinked into Homebrew's prefix (e.g. `/usr/local`)
**Caskroom**: All **Casks** are installed here **cellar**: directory containing one or more named **racks** e.g. `/usr/local/Cellar`
**Tap**: A Git repository of **Formulae** and/or commands **Caskroom**: directory containing one or more named **casks** e.g. `/usr/local/Caskroom`
**Bottle**: Pre-built **Keg** used instead of building from source **external command**: `brew` subcommand defined outside of the Homebrew/brew GitHub repository
**tap**: directory (and usually Git repository) of **formulae**, **casks** and/or **external commands**
**bottle**: pre-built **keg** poured into the **cellar**/**rack** instead of building from upstream sources
## ESSENTIAL COMMANDS ## ESSENTIAL COMMANDS

20
docs/Manpage.md
View File

@ -14,21 +14,25 @@ Linux distribution to your home directory without requiring `sudo`.
## TERMINOLOGY ## TERMINOLOGY
**Formula**: The package definition **formula**: Homebrew package definition built from upstream sources
**Cask**: An extension of Homebrew to install macOS native apps **cask**: Homebrew package definition that installs macOS native applications
**Keg**: The installation prefix of a **Formula** **keg**: installation destination directory of a given **formula** version e.g. `/usr/local/Cellar/foo/0.1`
**Keg-only**: A **Formula** is **Keg-only** if it is not linked into the Homebrew prefix **rack**: directory containing one or more versioned kegs e.g. `/usr/local/Cellar/foo`
**Cellar**: All **Kegs** are installed here **keg-only**: a **formula** is **keg-only** if it is not symlinked into Homebrew's prefix (e.g. `/usr/local`)
**Caskroom**: All **Casks** are installed here **cellar**: directory containing one or more named **racks** e.g. `/usr/local/Cellar`
**Tap**: A Git repository of **Formulae** and/or commands **Caskroom**: directory containing one or more named **casks** e.g. `/usr/local/Caskroom`
**Bottle**: Pre-built **Keg** used instead of building from source **external command**: `brew` subcommand defined outside of the Homebrew/brew GitHub repository
**tap**: directory (and usually Git repository) of **formulae**, **casks** and/or **external commands**
**bottle**: pre-built **keg** poured into the **cellar**/**rack** instead of building from upstream sources
## ESSENTIAL COMMANDS ## ESSENTIAL COMMANDS

38
manpages/brew.1
View File

@ -16,36 +16,44 @@
Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\. It can also install software not packaged for your Linux distribution to your home directory without requiring \fBsudo\fR\. Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\. It can also install software not packaged for your Linux distribution to your home directory without requiring \fBsudo\fR\.
. .
.SH "TERMINOLOGY" .SH "TERMINOLOGY"
\fBFormula\fR \fBformula\fR
The package definition Homebrew package definition built from upstream sources
. .
.P .P
\fBCask\fR \fBcask\fR
An extension of Homebrew to install macOS native apps Homebrew package definition that installs macOS native applications
. .
.P .P
\fBKeg\fR \fBkeg\fR
The installation prefix of a \fBFormula\fR installation destination directory of a given \fBformula\fR version e\.g\. \fB/usr/local/Cellar/foo/0\.1\fR
. .
.P .P
\fBKeg\-only\fR \fBrack\fR
A \fBFormula\fR is \fBKeg\-only\fR if it is not linked into the Homebrew prefix directory containing one or more versioned kegs e\.g\. \fB/usr/local/Cellar/foo\fR
. .
.P .P
\fBCellar\fR \fBkeg\-only\fR
All \fBKegs\fR are installed here a \fBformula\fR is \fBkeg\-only\fR if it is not symlinked into Homebrew\'s prefix (e\.g\. \fB/usr/local\fR)
.
.P
\fBcellar\fR
directory containing one or more named \fBracks\fR e\.g\. \fB/usr/local/Cellar\fR
. .
.P .P
\fBCaskroom\fR \fBCaskroom\fR
All \fBCasks\fR are installed here directory containing one or more named \fBcasks\fR e\.g\. \fB/usr/local/Caskroom\fR
. .
.P .P
\fBTap\fR \fBexternal command\fR
A Git repository of \fBFormulae\fR and/or commands \fBbrew\fR subcommand defined outside of the Homebrew/brew GitHub repository
. .
.P .P
\fBBottle\fR \fBtap\fR
Pre\-built \fBKeg\fR used instead of building from source directory (and usually Git repository) of \fBformulae\fR, \fBcasks\fR and/or \fBexternal commands\fR
.
.P
\fBbottle\fR
pre\-built \fBkeg\fR poured into the \fBcellar\fR/\fBrack\fR instead of building from upstream sources
. .
.SH "ESSENTIAL COMMANDS" .SH "ESSENTIAL COMMANDS"
For the full command list, see the \fICOMMANDS\fR section\. For the full command list, see the \fICOMMANDS\fR section\.