PowerShell/docs/building/macos.md

# Build PowerShell on macOS

This guide supplements the [Linux instructions](./linux.md), as
building on macOS is almost identical.

.NET Core 2.0 (and by transitivity, us) only supports macOS 10.12.

## Environment

You will want [Homebrew](http://brew.sh/), the missing package manager for macOS.
Once installed, follow the same instructions to download and
install a self-hosted copy of PowerShell on your macOS machine,
and use`Start-PSBootstrap` to install the dependencies.

The `Start-PSBootstrap` function does the following:

- Uses `brew` to install CMake, OpenSSL, and GNU WGet
- Uninstalls any prior versions of .NET CLI
- Downloads and installs a preview version of .NET Core SDK 2.0 to `~/.dotnet`

If you want to use `dotnet` outside of `Start-PSBuild`,
add `~/.dotnet` to your `PATH` environment variable.

### error: Too many open files

Due to a [bug][809] in NuGet, the `dotnet restore` command will fail without the limit increased.
Run `ulimit -n 2048` to fix this in your session;
add it to your shell's profile to fix it permanently.

We cannot do this for you in the build module due to #[847][].

[809]: https://github.com/dotnet/cli/issues/809
[847]: https://github.com/PowerShell/PowerShell/issues/847

## Build using our module

Instead of installing the Ubuntu package of PowerShell,
download the `pkg` from our GitHub releases page using your browser, complete the wizard,
start a `powershell` session, and use `Start-PSBuild` from the module.

After building, PowerShell will be at `./src/powershell-unix/bin/Linux/netcoreapp2.0/osx.10.12-x64/publish/powershell`.
Note that configuration is still `Linux` because it would be silly to make yet another separate configuration when it's used solely to work-around a CLI issue.
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			`# Build PowerShell on macOS`
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
			`This guide supplements the [Linux instructions](./linux.md), as`
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core. 2016-08-27 03:08:50 +08:00			`building on macOS is almost identical.`
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			`.NET Core 2.0 (and by transitivity, us) only supports macOS 10.12.`
Update documentation for OS X testing Copy the Travis CI badge for 10.11. It is the same badge, but it will fail if the build fails. I don't see a way to have separate badges, but this highlights that the platform is being tested. 2016-04-15 02:25:09 +08:00
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			`## Environment`
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core. 2016-08-27 03:08:50 +08:00			`You will want [Homebrew](http://brew.sh/), the missing package manager for macOS.`
Use one fragment per line in Markdown 2016-07-22 06:50:04 +08:00			`Once installed, follow the same instructions to download and`
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core. 2016-08-27 03:08:50 +08:00			`install a self-hosted copy of PowerShell on your macOS machine,`
Use one fragment per line in Markdown 2016-07-22 06:50:04 +08:00			and use`Start-PSBootstrap` to install the dependencies.
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
Update documentation for Start-PSBootstrap Also moved Git setup section first. 2016-04-14 07:21:23 +08:00			The `Start-PSBootstrap` function does the following:
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
Update documentation for Start-PSBootstrap Also moved Git setup section first. 2016-04-14 07:21:23 +08:00			- Uses `brew` to install CMake, OpenSSL, and GNU WGet
Update building documentations for Linux and OS X 2016-06-11 07:06:08 +08:00			`- Uninstalls any prior versions of .NET CLI`
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			- Downloads and installs a preview version of .NET Core SDK 2.0 to `~/.dotnet`
Deal with paths magically in Start-PSBuild 2016-04-14 07:41:50 +08:00
Use one fragment per line in Markdown 2016-07-22 06:50:04 +08:00			If you want to use `dotnet` outside of `Start-PSBuild`,
			add `~/.dotnet` to your `PATH` environment variable.
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			`### error: Too many open files`
Update documentation for OS X testing Copy the Travis CI badge for 10.11. It is the same badge, but it will fail if the build fails. I don't see a way to have separate badges, but this highlights that the platform is being tested. 2016-04-15 02:25:09 +08:00
Use one fragment per line in Markdown 2016-07-22 06:50:04 +08:00			Due to a [bug][809] in NuGet, the `dotnet restore` command will fail without the limit increased.
			Run `ulimit -n 2048` to fix this in your session;
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			`add it to your shell's profile to fix it permanently.`
Update documentation for OS X testing Copy the Travis CI badge for 10.11. It is the same badge, but it will fail if the build fails. I don't see a way to have separate badges, but this highlights that the platform is being tested. 2016-04-15 02:25:09 +08:00
fix typos in building/osx.md Removed doubled "in". soley -> solely 2016-08-19 01:47:23 +08:00			`We cannot do this for you in the build module due to #[847][].`
Update documentation for OS X testing Copy the Travis CI badge for 10.11. It is the same badge, but it will fail if the build fails. I don't see a way to have separate badges, but this highlights that the platform is being tested. 2016-04-15 02:25:09 +08:00
			`[809]: https://github.com/dotnet/cli/issues/809`
			`[847]: https://github.com/PowerShell/PowerShell/issues/847`

Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			`## Build using our module`
Document OS X dependency installation instructions 2016-03-31 05:30:13 +08:00
Use one fragment per line in Markdown 2016-07-22 06:50:04 +08:00			`Instead of installing the Ubuntu package of PowerShell,`
			download the `pkg` from our GitHub releases page using your browser, complete the wizard,
			start a `powershell` session, and use `Start-PSBuild` from the module.

Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-19 04:12:35 +08:00			After building, PowerShell will be at `./src/powershell-unix/bin/Linux/netcoreapp2.0/osx.10.12-x64/publish/powershell`.
fix typos in building/osx.md Removed doubled "in". soley -> solely 2016-08-19 01:47:23 +08:00			Note that configuration is still `Linux` because it would be silly to make yet another separate configuration when it's used solely to work-around a CLI issue.