mirrors/PowerShell
0
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell.git synced 2024-12-04 15:24:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1419 from alexandair/patch-6

Browse Source 
Update linux.md
This commit is contained in:
Jianyun 2016-07-19 10:22:13 -07:00 committed by GitHub
commit bc3e4d9e58
1 changed files with 46 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
docs/building/linux.md
View File

@ -1,33 +1,30 @@
Build PowerShell on Linux Build PowerShell on Linux
========================= =========================
This guide will walk you through building PowerShell on Linux. We'll This guide will walk you through building PowerShell on Linux.
start by showing how to set up your environment from scratch. We'll start by showing how to set up your environment from scratch.
Environment Environment
=========== ===========
These instructions are written assuming the Ubuntu 14.04 LTS, since that's the These instructions are written assuming the Ubuntu 14.04 LTS, since that's the distro the team uses.
distro the team uses. The build module works on a best-effort basis for other The build module works on a best-effort basis for other distributions.
distributions.
Git Setup Git Setup
--------- ---------
Using Git requires it to be setup correctly; refer to the Using Git requires it to be set up correctly;
[Working With the PowerShell Repository](../git/powershell-repository-101.md), refer to the [Working with the PowerShell Repository](../git/powershell-repository-101.md),
[README](../../README.md) and [README](../../README.md), and [Contributing Guidelines](../../.github/CONTRIBUTING.md).
[Contributing Guidelines](../../.github/CONTRIBUTING.md).
**This guide assumes that you have recursively cloned the PowerShell **This guide assumes that you have recursively cloned the PowerShell repository and `cd`ed into it.**
repository and `cd`ed into it.**
Toolchain Setup Toolchain Setup
--------------- ---------------
We use the [.NET Command Line Interface][dotnet-cli] (`dotnet`) to We use the [.NET Command-Line Interface][dotnet-cli] (`dotnet`) to build the managed components,
build the managed components, and [CMake][] to build the native and [CMake][] to build the native components.
components. Install the following packages for the toolchain: Install the following packages for the toolchain:
- `dotnet`: Must be installed from the `Start-PSBootstrap` module as described below. - `dotnet`: Must be installed from the `Start-PSBootstrap` module as described below.
- `cmake` - `cmake`
@ -35,22 +32,19 @@ components. Install the following packages for the toolchain:
- `g++` - `g++`
Unfortunately, the `apt-get` feed for `dotnet` has been deprecated, Unfortunately, the `apt-get` feed for `dotnet` has been deprecated,
and the latest version is only distributed in the form of three and the latest version is only distributed in the form of three separate packages,
separate packages, which require manual dependency resolution. which require manual dependency resolution.
Installing the toolchain is as easy as running `Start-PSBootstrap` in Installing the toolchain is as easy as running `Start-PSBootstrap` in PowerShell.
PowerShell. Of course, this requires a self-hosted copy of PowerShell Of course, this requires a self-hosted copy of PowerShell on Linux.
on Linux.
Fortunately, this is as easy as downloading and installing the Fortunately, this is as easy as downloading and installing the package.
package. Unfortunately, while the repository is still private, the Unfortunately, while the repository is still private, the package cannot be downloaded as simply as with `wget`.
package cannot be downloaded as simply as with `wget`. We have a We have a script that wraps the GitHub API and uses a personal access token to authorize in order to obtain the package.
script that wraps the GitHub API and uses a personal access token to
authorize in order to obtain the package.
The `./tools/download.sh` script will also install the PowerShell package. The `./tools/download.sh` script will also install the PowerShell package.
> You can alternativelly download via a browser, upload it to your > You can alternatively download by using a browser, upload it to your
> box via some other method, and manually install it. > box via some other method, and manually install it.
In Bash: In Bash:
@ -62,9 +56,8 @@ GITHUB_TOKEN=<replace with your token>
powershell powershell
``` ```
You should now be in a `powershell` console host that is installed You should now be in a `powershell` console host that is installed separately from any development copy you're about to build.
separately from any development copy you're about to build. Just Just import our module, bootstrap the dependencies, and build!
import our module, bootstrap the dependencies, and build!
In PowerShell: In PowerShell:
@ -76,13 +69,11 @@ Start-PSBootstrap
The `Start-PSBootstrap` function does the following: The `Start-PSBootstrap` function does the following:
- Adds the LLVM package feed - Adds the LLVM package feed
- Installs our dependencies combined with the dependencies of the .NET - Installs our dependencies combined with the dependencies of the .NET CLI toolchain via `apt-get`
CLI toolchain via `apt-get`
- Uninstalls any prior versions of .NET CLI - Uninstalls any prior versions of .NET CLI
- Downloads and installs the latest .NET CLI 1.0.0-preview2 SDK to `~/.dotnet` - Downloads and installs the latest .NET CLI 1.0.0-preview2 SDK to `~/.dotnet`
If you want to use `dotnet` outside of `Start-PSBuild`, add `~/.dotnet` to your If you want to use `dotnet` outside of `Start-PSBuild`, add `~/.dotnet` to your `PATH` environment variable.
`PATH` environment variable.
[dotnet-cli]: https://github.com/dotnet/cli#new-to-net-cli [dotnet-cli]: https://github.com/dotnet/cli#new-to-net-cli
[CMake]: https://cmake.org/cmake/help/v2.8.12/cmake.html [CMake]: https://cmake.org/cmake/help/v2.8.12/cmake.html
@ -90,25 +81,21 @@ If you want to use `dotnet` outside of `Start-PSBuild`, add `~/.dotnet` to your
.NET CLI .NET CLI
-------- --------
If you have any problems installing `dotnet`, please see their If you have any problems installing `dotnet`, please see their [documentation][cli-docs].
[documentation][cli-docs].
The version of .NET CLI is very important, you need a recent build of The version of .NET CLI is very important; you need a recent build of 1.0.0 (**not** 1.0.1).
1.0.0 (**not** 1.0.1).
Previous installations of DNX, `dnvm`, or older installations of .NET Previous installations of DNX, `dnvm`, or older installations of .NET CLI can cause odd failures when running.
CLI can cause odd failures when running. Please check your version and Please check your version and uninstall prior any prior versions.
uninstall prior any prior versions.
[cli-docs]: https://dotnet.github.io/getting-started/ [cli-docs]: https://dotnet.github.io/getting-started/
Build using our module Build using our module
====================== ======================
We maintain a [PowerShell module](../../build.psm1) with We maintain a [PowerShell module](../../build.psm1) with the function `Start-PSBuild` to build PowerShell.
the function `Start-PSBuild` to build PowerShell. Since this is Since this is PowerShell code, it requires self-hosting.
PowerShell code, it requires self-hosting. If you have followed the If you have followed the toolchain setup section above, you should have `powershell` installed.
toolchain setup section above, you should have `powershell` installed.
> If you cannot or do not want to self-host, `Start-PSBuild` is just a > If you cannot or do not want to self-host, `Start-PSBuild` is just a
> convenience; you can execute each step of the build process yourself > convenience; you can execute each step of the build process yourself
@ -123,9 +110,8 @@ The `Start-PSBuild` script will output the location of the executable:
`./src/powershell/bin/Linux/netcoreapp1.0/ubuntu.14.04-x64/powershell`. `./src/powershell/bin/Linux/netcoreapp1.0/ubuntu.14.04-x64/powershell`.
You should now be running the `powershell` that is what you just built if your run the above executable. You should now be running the `powershell` that you just built, if your run the above executable.
You can run our cross-platform Pester tests with `Start-PSPester`, and You can run our cross-platform Pester tests with `Start-PSPester`, and our xUnit tests with `Start-PSxUnit`.
our xUnit tests with `Start-PSxUnit`.
Build manually Build manually
============== ==============
@ -135,8 +121,7 @@ The following goes into detail about what `Start-PSBuild` does.
Build the native library Build the native library
------------------------ ------------------------
The `libpsl-native.so` library consists of native functions that The `libpsl-native.so` library consists of native functions that `CorePsPlatform.cs` P/Invokes.
`CorePsPlatform.cs` P/Invokes.
```sh ```sh
pushd src/libpsl-native pushd src/libpsl-native
@ -146,16 +131,15 @@ make test
popd popd
``` ```
This library will be emitted in the `src/powershell` project, where `dotnet` This library will be emitted in the `src/powershell` project,
consumes it as "content" and thus automatically deploys it. where `dotnet` consumes it as "content" and thus automatically deploys it.
Build the managed projects Build the managed projects
-------------------------- --------------------------
The `powershell` project is the .NET Core PowerShell host. It is the top level The `powershell` project is the .NET Core PowerShell host.
project, so `dotnet build` transitively builds all its dependencies, and emits a It is the top level project, so `dotnet build` transitively builds all its dependencies, and emits a `powershell` executable.
`powershell` executable. The `--configuration Linux` flag is necessary to ensure The `--configuration Linux` flag is necessary to ensure that the preprocessor definition `LINUX` is defined (see [issue #673][]).
that the preprocessor definition `LINUX` is defined (see [issue #673][]).
```sh ```sh
dotnet restore dotnet restore
@ -163,16 +147,14 @@ cd src/powershell
dotnet build --configuration Linux dotnet build --configuration Linux
``` ```
The executable will be in The executable will be in `./bin/[configuration]/[framework]/[rid]/[binary name]`,
`./bin/[configuration]/[framework]/[rid]/[binary name]`, where our where our configuration is `Linux`, framework is `netcoreapp1.0`,
configuration is `Linux`, framework is `netcoreapp1.0`, runtime runtime identifier is `ubuntu.14.04-x64`, and binary name is `powershell`.
identifier is `ubuntu.14.04-x64`, and binary name is `powershell`. The The function `Get-PSOutput` will return the path to the executable;
function `Get-PSOutput` will return the path to the executable; thus thus you can execute the development copy via `& (Get-PSOutput)`.
you can execute the development copy via `& (Get-PSOutput)`.
For deploying PowerShell, `dotnet publish` will emit a `publish` For deploying PowerShell, `dotnet publish` will emit a `publish` directory that contains a flat list of every dependency required for
directory that contains a flat list of every dependency required for PowerShell.
PowerShell. This can be copied to, say, `/usr/local/share/powershell` This can be copied to, for example, `/usr/local/share/powershell` or packaged.
or packaged.
[issue #673]: https://github.com/PowerShell/PowerShell/issues/673 [issue #673]: https://github.com/PowerShell/PowerShell/issues/673