Add docs/Linuxbrew.md #5483

sjackman · 2019-01-04T18:22:15Z

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same change?
Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes? Here's an example.
Have you successfully run brew style with your changes locally?
Have you successfully run brew tests with your changes locally?

jonchang · 2019-01-04T18:28:37Z

docs/Linuxbrew.md

+
+# Linuxbrew
+
+The Homebrew package manager may be used on Linux and Windows 10+, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about), as well as macOS. Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory and does not require root access. Recent versions of *glibc* and *gcc* may be installed in your home directory on an older distribution of Linux. A Linuxbrew installation does not use any libraries provided by your host system, except *glibc* and *gcc* if they are sufficiently current.


A Linuxbrew installation does not use any libraries provided by your host system, except *glibc* and *gcc* if they are sufficiently current. Otherwise, versions of *glibc* and *gcc* may be installed in your home directory on an older distribution of Linux.

First sentence:

Besides macOS, Homebrew also supports Linux and Windows 10+ (via its Windows Subsystem for Linux (WSL)).

I'm inclined to remove the mention of macOS, as its stating the obvious to say that Homebrew runs on macOS.

Maybe: "The Homebrew package manager may also be used on Linux and Windows 10+, using Windows Subsystem for Linux (WSL)."

I'm inclined to remove the mention of macOS, as its stating the obvious to say that Homebrew runs on macOS.

Agreed.

does not require root access

does not use the root user

may be installed in your home directory

may be installed in your Homebrew prefix (or some similar wording that still works if Linuxbrew is installed outside the home directory)

if they are sufficiently current.

if they are new enough

does not require root access.

does not use the root user.

went with does not require sudo.

@sjackman I'm being pedantic but I think it's worth noting when things like sudo are mentioned that after installation it doesn't use it (ever) rather than doesn't require it (which sounds like it will if it can)

Went with…

It can be installed in your home directory, in which case it does not use sudo.
…
The installation script installs Linuxbrew to /home/linuxbrew/.linuxbrew using sudo if possible and in your home directory at ~/.linuxbrew otherwise. Linuxbrew does not use sudo after installation.

iMichka · 2019-01-04T18:28:48Z

docs/Linuxbrew.md

+
+# Linuxbrew
+
+The Homebrew package manager may be used on Linux and Windows 10+, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about), as well as macOS. Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory and does not require root access. Recent versions of *glibc* and *gcc* may be installed in your home directory on an older distribution of Linux. A Linuxbrew installation does not use any libraries provided by your host system, except *glibc* and *gcc* if they are sufficiently current.


as well as macOS. -> as well as on macOS.?
Or maybe just remove that bit?

It does seem like stating the obvious.

iMichka · 2019-01-04T18:30:52Z

docs/README.md

@@ -7,6 +7,7 @@
 - [Frequently Asked Questions](FAQ.md)
 - [Common Issues](Common-Issues.md)
 - [`brew` Shell Completion](Shell-Completion.md)
+- [Linuxbrew: Homebrew on Linux and Windows](Linuxbrew.md)


There is an Installation page above for mac, should we add a comment there for a Linux installation? Or should we try to regroup both installation procedures in one page?

Eventually I'd like the same installation procedure (one-line shell snippet) to be used for both macOS and Linux. In the mean time, https://linuxbrew.sh will be the go-to resource for installation instructions.

"and Windows 10".

iMichka · 2019-01-04T18:33:49Z

docs/Linuxbrew.md

+ Can install software to your home directory and so does not require sudo
+ Install software not packaged by your host distribution
+ Install up-to-date versions of software when your host distribution is old
+ Use the same package manager to manage your macOS, Linux, and Windows systems


Is that text not already somewhere else in the mac doc?

It may be, but I don't think it hurts to reiterate the fact here as a feature of Linuxbrew.

I concur with @iMichka: this section is redundant IMHO

These features are particularly relevant to Linux users of Homebrew.

Feels a bit weird to list features after install instructions

Move Features above Install.

iMichka · 2019-01-04T18:34:14Z

docs/Linuxbrew.md

+
+- [@Linuxbrew on Twitter](https://twitter.com/Linuxbrew)
+- [Linuxbrew/core on GitHub](https://github.com/Linuxbrew/homebrew-core)
+- [Linuxbrew Discourse](https://discourse.brew.sh/c/linuxbrew)


This should go on the main homebrew readme page.

Agreed, but it doesn't hurt to reiterate it here.

"Linuxbrew category of Homebrew's Discourse"

iMichka · 2019-01-04T18:34:37Z

docs/Linuxbrew.md

+
+[<img alt="CircleCI logo" style="height:1in" src="https://assets.brandfolder.com/otz6k5-cj8pew-e4rk9u/original/circle-logo-horizontal-black.png">](https://circleci.com/)
+
+[![Downloads by Bintray](https://bintray.com/docs/images/downloads_by_bintray_96.png)](https://bintray.com/linuxbrew)


And this part can go on the main readme page too.

We both use Bintray, and that's acknowledged already. Homebrew doesn't use CircleCI though, so here is a better spot for it.

maxim-belkin · 2019-01-04T18:58:32Z

docs/Linuxbrew.md

+
+[Features](#features), [dependencies](#dependencies) and [installation instructions](#install) are described below. Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained in the documentation](https://docs.brew.sh/Formula-Cookbook#homebrew-terminology).
+
+# Install


I suggest using ## Install: there should be only one header (# Linuxbrew) IMHO.

In my opinion, <title> is for the title of the document, and <h1> (aka #) is for the first level of section headers.

I agree with @maxim-belkin. This will look weird on docs.brew.sh otherwise.

Alrighty. I'll give in… this time. =p

maxim-belkin · 2019-01-04T19:00:45Z

docs/Linuxbrew.md

+
+# Install
+
+The installation script installs Linuxbrew to `/home/linuxbrew/.linuxbrew` if possible and in your home directory at `~/.linuxbrew` otherwise. Using `/home/linuxbrew/.linuxbrew` allows the use of more binary packages, called bottles, than installing in your personal home directory.


, called bottles, ~> ("bottles") or ,aka "bottles", or ("bottles" in Homebrew terminology)
than ~> rather than

I generally prefer parenthetical commas over parentheses in my writing. I don't feel strongly about this one. Perhaps

… binary packages (bottles) than installing …

$ rg 'binary.*bottle|bottle.*binary' diagnostic.rb: You can install Homebrew anywhere you want but some bottles (binary packages) brew.sh:you being able to use all the binary packages (bottles) Homebrew provides. We build_options.rb: # True if a {Formula} is being built as a bottle (i.e. binary package). formula.rb: # When installing a bottle (binary package) from a local path this will be cmd/vendor-install.sh:both Bintray (used for Homebrew bottles/binary packages) and GitHub dev-cmd/bottle.rb:#: Generate a bottle (binary package) from a formula that was installed with dev-cmd/bottle.rb: Generate a bottle (binary package) from a formula that was installed with extend/os/linux/diagnostic.rb: You will be unable to use binary packages (bottles).

Looks like parenthetical style for defining bottles is more common in the Homebrew codebase.

if possible

when would it not be possible?

agreed with matching existing style

The installation script installs Linuxbrew to /home/linuxbrew/.linuxbrew if possible

when would it not be possible?

When the user does not have sudo permissions on their system.

maxim-belkin · 2019-01-04T19:01:52Z

docs/Linuxbrew.md

+
+```sh
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/install/master/install.sh)"
+```


I suggest moving this snippet up to right below the # Install and then going into details about it...

maxim-belkin · 2019-01-04T19:02:27Z

docs/Linuxbrew.md

+sh -c "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/install/master/install.sh)"
+```
+
+Follow the *Next steps* instructions to add Linuxbrew to your `PATH` and to your bash shell profile script, either `~/.profile` on Debian/Ubuntu or `~/.bash_profile` on CentOS/Fedora/RedHat.


why *Next steps*?

That's the text output by the installer script for both Homebrew and Linuxbrew.

sudo -> sudo ?

maxim-belkin · 2019-01-04T19:05:49Z

docs/Linuxbrew.md

+
+```sh
+test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)
+test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)


it just occurred to me... -d tests if directory exists. We need to test -d, -w, and -x

If the directory exists, I prefer the user get an error message if it's not also -w or -x, as with the current code.

What if neither exist?

These commands are meant to be run after a successful run of sh -c "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/install/master/install.sh)", after which one of these two directories will exist.

maxim-belkin · 2019-01-04T19:10:49Z

docs/Linuxbrew.md

+
+# Bottles
+
+Bottles are Linuxbrew's precompiled binary packages. Linuxbrew bottles work on any Linux system. If you're using an older distribution of Linux, installing your first package will also install a recent version of `glibc` and `gcc`.


I prefer not to add scare quotes around each use of the word bottles.

This seems to repeat stuff from above.

MikeMcQuaid · 2019-01-04T20:37:34Z

docs/Linuxbrew.md

+
+# Linuxbrew
+
+The Homebrew package manager may be used on Linux and Windows 10+, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about), as well as macOS. Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory and does not require root access. Recent versions of *glibc* and *gcc* may be installed in your home directory on an older distribution of Linux. A Linuxbrew installation does not use any libraries provided by your host system, except *glibc* and *gcc* if they are sufficiently current.


I'm inclined to remove the mention of macOS, as its stating the obvious to say that Homebrew runs on macOS.

Agreed.

does not require root access

does not use the root user

may be installed in your home directory

may be installed in your Homebrew prefix (or some similar wording that still works if Linuxbrew is installed outside the home directory)

if they are sufficiently current.

if they are new enough

MikeMcQuaid · 2019-01-04T20:38:08Z

docs/Linuxbrew.md

+
+The Homebrew package manager may be used on Linux and Windows 10+, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about), as well as macOS. Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory and does not require root access. Recent versions of *glibc* and *gcc* may be installed in your home directory on an older distribution of Linux. A Linuxbrew installation does not use any libraries provided by your host system, except *glibc* and *gcc* if they are sufficiently current.
+
+[Features](#features), [dependencies](#dependencies) and [installation instructions](#install) are described below. Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained in the documentation](https://docs.brew.sh/Formula-Cookbook#homebrew-terminology).


Ideally use a Markdown file link here instead

MikeMcQuaid · 2019-01-04T20:38:45Z

docs/Linuxbrew.md

+
+[Features](#features), [dependencies](#dependencies) and [installation instructions](#install) are described below. Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained in the documentation](https://docs.brew.sh/Formula-Cookbook#homebrew-terminology).
+
+# Install


I agree with @maxim-belkin. This will look weird on docs.brew.sh otherwise.

MikeMcQuaid · 2019-01-04T20:39:42Z

docs/Linuxbrew.md

+
+# Install
+
+The installation script installs Linuxbrew to `/home/linuxbrew/.linuxbrew` if possible and in your home directory at `~/.linuxbrew` otherwise. Using `/home/linuxbrew/.linuxbrew` allows the use of more binary packages, called bottles, than installing in your personal home directory.


if possible

when would it not be possible?

agreed with matching existing style

MikeMcQuaid · 2019-01-04T20:41:01Z

docs/Linuxbrew.md

+
+```sh
+test -d ~/.linuxbrew && eval $(~/.linuxbrew/bin/brew shellenv)
+test -d /home/linuxbrew/.linuxbrew && eval $(/home/linuxbrew/.linuxbrew/bin/brew shellenv)


What if neither exist?

MikeMcQuaid · 2019-01-04T20:43:26Z

docs/Linuxbrew.md

+
+## Raspberry Pi
+
+Linuxbrew can run on Raspberry Pi (32-bit ARM), but no binary packages (bottles) are available. Support for Raspberry Pi is on a best-effort basis. Pull requests are welcome to improve the experience on Raspberry Pi.


If a "best-effort basis" and no binary packages I think this should be stated by brew doctor and the pre-installation instructions (like on old versions of macOS)

Okay. I'll address that in a separate PR.

Cool, thanks.

MikeMcQuaid · 2019-01-04T20:44:17Z

docs/Linuxbrew.md

+
+## 32-bit x86
+
+Linuxbrew does not currently support 32-bit x86 platforms. It would be possible for Linuxbrew to work on 32-bit x86 platforms with some effort. Pull requests would be welcome if someone were to volunteer to maintain the 32-bit x86 support.


Personally I'm not sure the "pull requests would be welcome" part; it'd better be to suggest starting a dedicated fork like Tigerbrew and it could be merged back if it's used.

Went with…

Linuxbrew does not currently support 32-bit x86 platforms. It would be possible for Linuxbrew to work on 32-bit x86 platforms with some effort. An interested and dedicated person could maintain a fork of Homebrew to develop support for 32-bit x86.

MikeMcQuaid · 2019-01-04T20:44:32Z

docs/Linuxbrew.md

+
+# Bottles
+
+Bottles are Linuxbrew's precompiled binary packages. Linuxbrew bottles work on any Linux system. If you're using an older distribution of Linux, installing your first package will also install a recent version of `glibc` and `gcc`.


This seems to repeat stuff from above.

MikeMcQuaid · 2019-01-04T20:45:10Z

docs/Linuxbrew.md

+
+- [@Linuxbrew on Twitter](https://twitter.com/Linuxbrew)
+- [Linuxbrew/core on GitHub](https://github.com/Linuxbrew/homebrew-core)
+- [Linuxbrew Discourse](https://discourse.brew.sh/c/linuxbrew)


"Linuxbrew category of Homebrew's Discourse"

MikeMcQuaid · 2019-01-04T20:45:35Z

docs/README.md

@@ -7,6 +7,7 @@
 - [Frequently Asked Questions](FAQ.md)
 - [Common Issues](Common-Issues.md)
 - [`brew` Shell Completion](Shell-Completion.md)
+- [Linuxbrew: Homebrew on Linux and Windows](Linuxbrew.md)


"and Windows 10".

sjackman · 2019-01-04T23:26:48Z

I believe I've addressed all your comments. Thanks for your feedback. Ready for re-review.

MikeMcQuaid

Thanks @sjackman!

maxim-belkin · 2019-01-06T18:17:22Z

docs/Linuxbrew.md

+
+# Linuxbrew
+
+The Homebrew package manager may be used on Linux and Windows 10, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about). Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory, in which case it does not use sudo. Linuxbrew does not use any libraries provided by your host system, except *glibc* and *gcc* if they are new enough. Linuxbrew can install its own current versions of *glibc* and *gcc* for older distribution of Linux.


sudo -> sudo ?

Went with sudo

maxim-belkin · 2019-01-06T18:18:47Z

docs/Linuxbrew.md

+
+- [@Linuxbrew on Twitter](https://twitter.com/Linuxbrew)
+- [Linuxbrew/core on GitHub](https://github.com/Linuxbrew/homebrew-core)
+- [Linuxbrew category of Homebrew's Discourse](https://discourse.brew.sh/c/linuxbrew)


[Linuxbrew category](https://discourse.brew.sh/c/linuxbrew) of [Homebrew's Discourse](proper-link-here) ?

sjackman self-assigned this Jan 4, 2019

sjackman requested review from iMichka, jonchang and MikeMcQuaid January 4, 2019 18:22

maxim-belkin approved these changes Jan 4, 2019

View reviewed changes

jonchang reviewed Jan 4, 2019

View reviewed changes

jonchang approved these changes Jan 4, 2019

View reviewed changes

iMichka reviewed Jan 4, 2019

View reviewed changes

maxim-belkin reviewed Jan 4, 2019

View reviewed changes

MikeMcQuaid reviewed Jan 4, 2019

View reviewed changes

sjackman force-pushed the docs-linuxbrew branch from ef805ef to 9b09cdf Compare January 4, 2019 23:26

sjackman force-pushed the docs-linuxbrew branch from 9b09cdf to 98723c4 Compare January 6, 2019 17:01

MikeMcQuaid approved these changes Jan 6, 2019

View reviewed changes

maxim-belkin reviewed Jan 6, 2019

View reviewed changes

sjackman force-pushed the docs-linuxbrew branch from 98723c4 to 441d28d Compare January 6, 2019 18:53

Add docs/Linuxbrew.md

f25eff1

sjackman force-pushed the docs-linuxbrew branch from 441d28d to f25eff1 Compare January 6, 2019 18:54

sjackman merged commit 464b41e into Homebrew:master Jan 7, 2019

sjackman deleted the docs-linuxbrew branch January 7, 2019 17:45

lock bot added the outdated PR was locked due to age label Feb 6, 2019

lock bot locked as resolved and limited conversation to collaborators Feb 6, 2019


		# Linuxbrew

		The Homebrew package manager may be used on Linux and Windows 10+, using [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about), as well as macOS. Homebrew is referred to as Linuxbrew when running on Linux or Windows. It can be installed in your home directory and does not require root access. Recent versions of glibc and gcc may be installed in your home directory on an older distribution of Linux. A Linuxbrew installation does not use any libraries provided by your host system, except glibc and gcc if they are sufficiently current.


		[<img alt="CircleCI logo" style="height:1in" src="https://assets.brandfolder.com/otz6k5-cj8pew-e4rk9u/original/circle-logo-horizontal-black.png">](https://circleci.com/)

		[![Downloads by Bintray](https://bintray.com/docs/images/downloads_by_bintray_96.png)](https://bintray.com/linuxbrew)


		[Features](#features), [dependencies](#dependencies) and [installation instructions](#install) are described below. Terminology (e.g. the difference between a Cellar, Tap, Cask and so forth) is [explained in the documentation](https://docs.brew.sh/Formula-Cookbook#homebrew-terminology).

		# Install


		# Bottles

		Bottles are Linuxbrew's precompiled binary packages. Linuxbrew bottles work on any Linux system. If you're using an older distribution of Linux, installing your first package will also install a recent version of `glibc` and `gcc`.


		## Raspberry Pi

		Linuxbrew can run on Raspberry Pi (32-bit ARM), but no binary packages (bottles) are available. Support for Raspberry Pi is on a best-effort basis. Pull requests are welcome to improve the experience on Raspberry Pi.


		## 32-bit x86

		Linuxbrew does not currently support 32-bit x86 platforms. It would be possible for Linuxbrew to work on 32-bit x86 platforms with some effort. Pull requests would be welcome if someone were to volunteer to maintain the 32-bit x86 support.

Add docs/Linuxbrew.md #5483

Add docs/Linuxbrew.md #5483

Conversation

sjackman commented Jan 4, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjackman Jan 4, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjackman commented Jan 4, 2019

MikeMcQuaid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjackman Jan 4, 2019 •

edited