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.x (and by transitivity, us) only supports macOS 10.12+.

## Environment

You will want [Homebrew](https://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.
From `pwsh.exe`, run `Import-Module ./build.psm1` 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 .NET Core SDK 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

Start a PowerShell session by running `pwsh`, and then use `Start-PSBuild` from the module.

After building, PowerShell will be at `./src/powershell-unix/bin/Debug/netcoreapp2.1/osx-x64/publish/pwsh`.
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-18 22:12:35 +02:00			`# Build PowerShell on macOS`
Document OS X dependency installation instructions 2016-03-30 23:30:13 +02: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-26 21:08:50 +02:00			`building on macOS is almost identical.`
Document OS X dependency installation instructions 2016-03-30 23:30:13 +02:00
Update docs about .NET Core version 2.0 to be about version 2.x (#7467) 2018-08-31 01:51:52 +02:00			`.NET Core 2.x (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-14 20:25:09 +02:00
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-18 22:12:35 +02:00			`## Environment`
Document OS X dependency installation instructions 2016-03-30 23:30:13 +02:00
Use https in URLs where available (#8622) Use https in URLS across the repository where the domain serves content by https. 2019-01-24 21:50:11 +01:00			`You will want [Homebrew](https://brew.sh/), the missing package manager for macOS.`
Use one fragment per line in Markdown 2016-07-22 00:50:04 +02:00			`Once installed, follow the same instructions to download and`
Doc: Add a missing step to prepare the build environment on Mac. (#5901) 2018-01-17 21:53:28 +01:00			`install a self-hosted copy of PowerShell on your macOS machine.`
			From `pwsh.exe`, run `Import-Module ./build.psm1` and use `Start-PSBootstrap` to install the dependencies.
Document OS X dependency installation instructions 2016-03-30 23:30:13 +02:00
Update documentation for Start-PSBootstrap Also moved Git setup section first. 2016-04-14 01:21:23 +02:00			The `Start-PSBootstrap` function does the following:
Document OS X dependency installation instructions 2016-03-30 23:30:13 +02:00
Update documentation for Start-PSBootstrap Also moved Git setup section first. 2016-04-14 01:21:23 +02:00			- Uses `brew` to install CMake, OpenSSL, and GNU WGet
Update building documentations for Linux and OS X 2016-06-11 01:06:08 +02:00			`- Uninstalls any prior versions of .NET CLI`
Update docs about .NET Core version 2.0 to be about version 2.x (#7467) 2018-08-31 01:51:52 +02:00			- Downloads and installs .NET Core SDK to `~/.dotnet`
Deal with paths magically in Start-PSBuild 2016-04-14 01:41:50 +02:00
Use one fragment per line in Markdown 2016-07-22 00:50:04 +02: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-30 23:30:13 +02:00
Update build script to always use 'dotnet publish' (#3589) Also update 2 building docs 2017-04-18 22:12:35 +02: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-14 20:25:09 +02:00
Use one fragment per line in Markdown 2016-07-22 00:50:04 +02: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-18 22:12:35 +02: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-14 20:25:09 +02:00
fix typos in building/osx.md Removed doubled "in". soley -> solely 2016-08-18 19:47:23 +02: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-14 20:25:09 +02: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-18 22:12:35 +02:00			`## Build using our module`
Document OS X dependency installation instructions 2016-03-30 23:30:13 +02:00
Add documentation about how to create libpsl and psrp.windows packages (#5278) - Add document about creating libpsl and psrp.windows nuget packages - Clean up and update the existing building docs. 2017-11-01 23:55:46 +01:00			Start a PowerShell session by running `pwsh`, and then use `Start-PSBuild` from the module.
Use one fragment per line in Markdown 2016-07-22 00:50:04 +02:00
Update the powershell executable location in building guide docs (#7205) 2018-06-29 08:14:08 +02:00			After building, PowerShell will be at `./src/powershell-unix/bin/Debug/netcoreapp2.1/osx-x64/publish/pwsh`.