mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
Add a last_reviewed_date
to docs metadata
- At the AGM we formed an ad-hoc documentation working group. - One of our ideas was that we should have a last reviewed date for documentation, so that we can periodically implement a review mechanism (GitHub Actions posts to Slack for a regular documentation outdatedness check?) to track how old docs are and ensure they're still relevant. - This is a first step towards that goal, by adding a `last_review_date` to the metadata of all docs with a date of earlier than Homebrew's inception because everything needs reviewing so that we start from a good base!
This commit is contained in:
parent
7101d3d49c
commit
31d7bcc583
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Acceptable Casks
|
||||
|
||||
Some casks should not go in [homebrew/cask](https://github.com/Homebrew/homebrew-cask). But there are additional [Interesting Taps and Forks](Interesting-Taps-and-Forks.md) and anyone can [start their own](How-to-Create-and-Maintain-a-Tap.md)!
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Acceptable Formulae
|
||||
|
||||
Some formulae should not go in [homebrew/core](https://github.com/Homebrew/homebrew-core). But there are additional [Interesting Taps and Forks](Interesting-Taps-and-Forks.md) and anyone can [start their own](How-to-Create-and-Maintain-a-Tap.md)!
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Adding Software to Homebrew
|
||||
|
||||
Is your favourite software missing from Homebrew? Then you're the perfect person to resolve this problem.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Anonymous Analytics
|
||||
|
||||
Homebrew gathers anonymous analytics using InfluxDB. You will be notified the first time you run `brew update` or install Homebrew. Analytics are not enabled until after this notice is shown, to ensure that you can [opt out](Analytics.md#opting-out) without ever sending analytics data.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Bottles (Binary Packages)
|
||||
|
||||
Bottles are produced by installing a formula with `brew install --build-bottle <formula>` and then bottling it with `brew bottle <formula>`. This generates a bottle file in the current directory and outputs the bottle DSL for insertion into the formula file.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# `brew livecheck`
|
||||
|
||||
The `brew livecheck` command finds the newest version of a formula or cask's software by checking upstream. Livecheck has [strategies](https://rubydoc.brew.sh/Homebrew/Livecheck/Strategy) to identify versions from various sources, such as Git repositories, websites, etc.
|
||||
|
@ -3,6 +3,7 @@ logo: /assets/img/brewtestbot.png
|
||||
image: /assets/img/brewtestbot.png
|
||||
redirect_from:
|
||||
- /Brew-Test-Bot-For-Core-Contributors
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# BrewTestBot for Maintainers
|
||||
|
@ -3,6 +3,7 @@ logo: /assets/img/brewtestbot.png
|
||||
image: /assets/img/brewtestbot.png
|
||||
redirect_from:
|
||||
- /Brew-Test-Bot
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# BrewTestBot
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Building Against Non-Homebrew Dependencies
|
||||
|
||||
## History
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# C++ Standard Libraries
|
||||
|
||||
There are two C++ standard libraries supported by Apple compilers.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Cask Cookbook
|
||||
|
||||
Each cask is a Ruby block, beginning with a special header line. The cask definition itself is always enclosed in a `do … end` block. Example:
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# MD5 and SHA-1 Deprecation
|
||||
|
||||
In early 2015 Homebrew started the process of deprecating _SHA1_ for package
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Common Issues for Maintainers
|
||||
|
||||
## Overview
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Common Issues
|
||||
|
||||
This is a list of commonly encountered problems, known issues, and their solutions.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Creating a Homebrew Issue
|
||||
|
||||
First, check to make sure your issue is not listed in the [FAQ](FAQ.md) or [Common Issues](Common-Issues.md) and can't otherwise be resolved with the information in the [Tips and Tricks](Tips-N'-Tricks.md) documentation. Next, go through the steps in the [Troubleshooting guide](Troubleshooting.md).
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Custom GCC and Cross Compilers
|
||||
|
||||
Homebrew depends on having an up-to-date version of Xcode because it comes with specific versions of build tools, e.g. `clang`. Installing a custom version of GCC or Autotools into your `PATH` has the potential to break lots of compiles so we prefer the Apple- or Homebrew-provided compilers. Cross compilers based on GCC will typically be "keg-only" and therefore not linked into your `PATH` by default, or be prefixed with the target architecture, again to avoid conflicting with Apple or Homebrew compilers.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Deprecating, Disabling and Removing Casks
|
||||
|
||||
There are many reasons why casks may be deprecated, disabled or removed. This document explains the differences between each method as well as explaining when one method should be used over another.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Deprecating, Disabling and Removing Formulae
|
||||
|
||||
There are many reasons why formulae may be deprecated, disabled or removed. This document explains the differences between each method as well as explaining when one method should be used over another.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# External Commands
|
||||
|
||||
Homebrew, like Git, supports *external commands*. This lets you create new commands that can be run like:
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# FAQ (Frequently Asked Questions)
|
||||
|
||||
* Table of Contents
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Formula Cookbook
|
||||
|
||||
A *formula* is a package definition written in Ruby. It can be created with `brew create <URL>` where `<URL>` is a zip or tarball, installed with `brew install <formula>`, and debugged with `brew install --debug --verbose <formula>`. Formulae use the [Formula API](https://rubydoc.brew.sh/Formula) which provides various Homebrew-specific helpers.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Gems, Eggs and Perl Modules
|
||||
|
||||
On a fresh macOS installation there are two empty directories for
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Governance Archives
|
||||
|
||||
{% assign governance_pages = site.pages | where: "category", "governance-archives" %}
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Governance
|
||||
|
||||
## 1. Definitions
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Leadership Responsibilities
|
||||
|
||||
## Project Leadership Committee
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew and Java
|
||||
|
||||
This page describes how Java is handled in Homebrew for users. Prospective formula authors may refer to existing Java-based formulae for examples of how to install packages written in Java via Homebrew, or visit the [Homebrew discussion forum](https://github.com/orgs/Homebrew/discussions) to seek guidance for their specific situation.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Python
|
||||
|
||||
This page describes how Python is handled in Homebrew for users. See [Python for Formula Authors](Python-for-Formula-Authors.md) for advice on writing formulae to install packages written in Python.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew/brew Maintainer Guide
|
||||
|
||||
This document describes a few components of the `Homebrew/brew` repository that are useful for maintainers to be aware of, but don't necessarily need to appear in documentation for most users and contributors.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew/homebrew-cask Maintainer Guide
|
||||
|
||||
This guide is intended to help maintainers effectively maintain the cask repository. It is meant to be used in conjunction with the more generic [Maintainer Guidelines](Maintainer-Guidelines.md).
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew/homebrew-core Maintainer Guide
|
||||
|
||||
## Quick merge checklist
|
||||
|
@ -5,6 +5,7 @@ redirect_from:
|
||||
- /linux
|
||||
- /Linux
|
||||
- /Linuxbrew
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew on Linux
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# How to Open a Homebrew Pull Request
|
||||
|
||||
The following commands are used by Homebrew contributors to set up a fork of Homebrew's Git repository on GitHub, create a new branch and create a GitHub pull request ("PR") for the changes in that branch.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# How To Organize AGM
|
||||
|
||||
AGM is our combination of business meeting, yearly work planning session, and opportunity to meet others in our international team in person.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# How to Build Software Outside Homebrew with Homebrew `keg_only` Dependencies
|
||||
|
||||
## What does "keg-only" mean?
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# How to Create and Maintain a Tap
|
||||
|
||||
[Taps](Taps.md) are external sources of Homebrew formulae, casks and/or external commands. They can be created by anyone to provide their own formulae, casks and/or external commands to any Homebrew user.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Instructions for a supported install of Homebrew are on the [homepage](https://brew.sh).
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Interesting Taps and Forks
|
||||
|
||||
A [tap](Taps.md) is Homebrew-speak for a Git repository containing additional formulae.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Kickstarter Supporters
|
||||
|
||||
This file contains a list of the awesome people who gave £5 or more to [our Kickstarter](https://www.kickstarter.com/projects/homebrew/brew-test-bot).
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# License Guidelines
|
||||
|
||||
We only accept formulae that use a [Debian Free Software Guidelines license](https://wiki.debian.org/DFSGLicenses) or are released into the public domain following [DFSG Guidelines on Public Domain software](https://wiki.debian.org/DFSGLicenses#Public_Domain) into `homebrew/core`.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Linux CI in `homebrew/core`
|
||||
|
||||
We currently use Ubuntu 22.04 for bottling in `homebrew/core`.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Maintainer Guidelines
|
||||
|
||||
**This guide is for maintainers.** These special people have **write access** to Homebrew’s repository and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not a beginner’s guide.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Maintainers: Avoiding Burnout
|
||||
|
||||
**This guide is for maintainers.** These special people have **write
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Migrating a Formula to a Tap
|
||||
|
||||
There are times when we may wish to migrate a formula from one tap into another tap. To do this:
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# New Maintainer Checklist
|
||||
|
||||
**Existing maintainers and project leadership uses this guide to invite and onboard new maintainers and project leaders.**
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Node for Formula Authors
|
||||
|
||||
This document explains how to successfully use Node and npm in a Node module based Homebrew formula.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Prose Style Guidelines
|
||||
|
||||
<!-- vale off -->
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Python for Formula Authors
|
||||
|
||||
This document explains how to successfully use Python in a Homebrew formula.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Querying `brew`
|
||||
|
||||
_In this document we will be using [jq](https://stedolan.github.io/jq/) to parse JSON, available from Homebrew using `brew install jq`._
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Docs
|
||||
|
||||
These are the source files for the [Homebrew documentation site](https://docs.brew.sh/).
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Releases
|
||||
|
||||
Since Homebrew 1.0.0 most Homebrew users (those who haven't run a `dev-cmd` or set `HOMEBREW_DEVELOPER=1` which is ~99.9% based on analytics data) require tags on the [Homebrew/brew repository](https://github.com/homebrew/brew) in order to receive new versions of Homebrew. There are a few steps in making a new Homebrew release:
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Renaming a Formula
|
||||
|
||||
Sometimes software and formulae need to be renamed. To rename a formula you need to:
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Reproducible Builds
|
||||
|
||||
The Homebrew build environment is designed with [reproducible builds](https://reproducible-builds.org) as a goal where possible. Some convenience tools are also available to formula authors to help achieve deterministic builds.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# `brew` Shell Completion
|
||||
|
||||
Homebrew comes with completion definitions for the `brew` command. Some packages also provide completion definitions for their own programs.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Taps (Third-Party Repositories)
|
||||
|
||||
The `brew tap` command adds more repositories to the list of formulae that Homebrew tracks, updates,
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Tips and Tricks
|
||||
|
||||
## Install previous versions of formulae
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
**Run `brew update` twice and `brew doctor` (and fix all the warnings) *before* creating an issue!**
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Type Checking With Sorbet
|
||||
|
||||
The majority of the code in Homebrew is written in Ruby which is a dynamic language. To avail the benefits of static type checking, we have set up Sorbet in our codebase which provides the benefits of static type checking to dynamic languages like Ruby.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Updating Software in Homebrew
|
||||
|
||||
Did you find something in Homebrew that wasn't the latest version? You can help yourself and others by submitting a pull request to update the formula.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Formulae Versions
|
||||
|
||||
[homebrew/core](https://github.com/homebrew/homebrew-core) supports multiple versions of formulae by using a special naming format. For example, the formula for GCC 9 is named `gcc@9.rb` and begins with `class GccAT9 < Formula`.
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Xcode
|
||||
|
||||
## Supported Xcode versions
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# 2019 Membership
|
||||
|
||||
- @alebcay
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Nomination for Mozilla Open Source Support, Track III
|
||||
|
||||
## Solicitation
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Project Leadership Committee Minutes 2019
|
||||
|
||||
## Members
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# 2020 Membership
|
||||
|
||||
- @alebcay
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Project Leadership Committee Minutes 2020
|
||||
|
||||
## Project Leader
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Annual General Meeting 2021
|
||||
|
||||
## Minutes
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Extraordinary General Meeting 2021
|
||||
|
||||
## 2021-01-14
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# 2021 Membership
|
||||
|
||||
- @alebcay
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Project Leadership Committee Minutes 2021
|
||||
|
||||
## Project Leader
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Annual General Meeting 2022
|
||||
|
||||
## Minutes
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# 2022 Membership
|
||||
|
||||
- @alebcay
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Annual General Meeting 2023
|
||||
|
||||
## Minutes
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Homebrew Annual General Meeting 2024
|
||||
|
||||
## Opening
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Documentation
|
||||
|
||||
## Users
|
||||
|
@ -1,3 +1,7 @@
|
||||
---
|
||||
last_review_date: "1970-01-01"
|
||||
---
|
||||
|
||||
# Vale Styles
|
||||
|
||||
Based on Homebrew's [Prose Style Guidelines](http://docs.brew.sh/Prose-Style-Guidelines.html).
|
||||
|
Loading…
x
Reference in New Issue
Block a user