diff --git a/src/dotnet/commands/dotnet-compile-csc/README.md b/src/dotnet/commands/dotnet-compile-csc/README.md deleted file mode 100644 index 359a48e4e2..0000000000 --- a/src/dotnet/commands/dotnet-compile-csc/README.md +++ /dev/null @@ -1,65 +0,0 @@ -dotnet-compile -=========== - -# NAME -dotnet-compile -- Compiles source files for a single project to a binary format and saves to a target file. - -# SYNOPSIS -dotnet compile [--output] [--build-base-path] [--framework] [--configuration] [--output] [--arch] [--verbose] - -# DESCRIPTION -The compile command compiles source files from a single project to a binary file, either intermediate language (IL) byte code or native machine code, depending on the options provided. The default option is compilation to IL byte code, but may change in the future. Users who want to benefit from incremental builds and who want to compile both the project and its dependencies should use the dotnet-build(1) command. - -The result of compilation is by default an executable file that can be ran. Output files, are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed. The temporary files that are created during compilation are placed in the child `obj` folder. - -The executables also require a special configuration section in project.json: - -```json -{ - "compilationOptions": { - "emitEntryPoint": true - } -} -``` - -The default native [--native] output is a native exe that conforms to the architecture of the underlying operating system (i.e. running on 64-bit OS will produce a native 64-bit exe). This can be overriden via the --arch switch and specifying the wanted architecture. The executable has a default extension of "" on Linux and OS X and ".exe" on Windows. The source must include a static void main entry point, or it is an error, unless otherwise specified in the project.json. The dynamic library [dylib] output option has the default extension of ".so" on Linux/UNIX, ".dynlib" on OS X and ".dll" on Windows. The static library [staticlib] option has the default extension of ".a" on Linux, UNIX and OS X and ".lib" on Windows. - -This command relies on the following artifacts: source files, project.json project file and the "lock" file (project.lock.json). Prior to invoking dotnet-compile, dotnet-restore(1) should be run to restore any dependencies that are needed for the application. - -# OPTIONS - -`-n, --native` -Compiles source to native machine code, for the local machine. The default is a native executable. The default executable extension is no extension and ".exe" on Windows. - -`-b, --build-base-path ` -Path where to drop the output produced during compile. By default, the binaries are dropped in the `bin` and `obj` directory in the directory where `project.json` files lives, that is, where the application lives. - -`-f, --framework ` -Compile the application for the specified framework. If the framework is not specified, one specified in `project.json` will be used. - -`-c, --configuration ` -Compile the application under the specified configuration. If not specified, the configuration will default to "Debug". - -`-o, --output filename` -Specifies the filename to be used. By default, the resulting filename will be the same as the project name specified in `project.json`, if one exists, or the directory in which the source files reside. - -`--no-project-dependencies` -Skips building cross-project references. The effect of this is that only the current project will be built. - -`-a, --arch` -The architecture for which to compile. x64 only currently supported. - -`--ilc-args ` -Specified parameters are passed through to ILC and are used by the engine when doing native compilation. - -`--cpp` -Specify the C++ code generator to do native compilation of code instead of the default RyuJIT. - -`-v, --verbose` -Prints verbose logging information, to follow the flow of execution of the command. - -`-h, --help` -Show short help. - -# SEE ALSO -dotnet-restore(1), dotnet-publish(1), dotnet(1) diff --git a/src/dotnet/commands/dotnet-compile-native/README.md b/src/dotnet/commands/dotnet-compile-native/README.md deleted file mode 100644 index 81e16b1c72..0000000000 --- a/src/dotnet/commands/dotnet-compile-native/README.md +++ /dev/null @@ -1,68 +0,0 @@ -% DOTNET-COMPILE-NATIVE(1) -% Zlatko Knezevic zlakne@microsoft.com -% January 2016 - -# NAME -dotnet-compile-native -- Compiles IL binaries to native binaries. - -# SYNOPSIS -dotnet compile [--appdepsdk] [--configuration] - [--ilcargs] [--linklib] [--logpath] - [--mode] [--out] [--reference] - [--temp-out] [--verbose] - -# DESCRIPTION -The `compile-native` command compiles IL assemblies to native machine code. It is used by `dotnet-compile --native`. - -The output is a native exe that conforms to the architecture of the underlying operating system (i.e. running on 64-bit OS will produce a native 64-bit exe). This can be overriden via the --arch switch and specifying the wanted architecture. The executable has a default extension of "" on Linux and OS X and ".exe" on Windows. The source must include a `static void Main(string[] args) entry point and specify compilationOptions.emitEntryPoint in the project.json. - -Output files are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed. - -# OPTIONS - -`--appdepsdk ` - - Path to custom AppDepSDK - -`-c, --configuration [debug|release]` - - Build configuration. Defaults to `debug`. - -`--ilcargs ` - - Custom arguments for the IL Compiler. - -`--ilcpath ` - - Path to a custom ilc.exe - -`--linklib ` - - Path to static lib to link - -`--logpath ` - - Enables logging and writes native compilation logs to the given path. - -`-m, --mode [cpp|ryujit|custom]` - - Code generation mode. Defaults to ryujit. - -`-o, --out directoryname` - - Output directory for the native executable. - -`-r, --reference` - - Path to a managed dll reference for the app. - -`-t, --temp-out` - - Specifies temporary directory for intermediate files. - -`-v, --verbose` - - Prints verbose logging information, to follow the flow of execution of the command. - -# SEE ALSO -dotnet-compile(1), dotnet(1), dotnet-restore(1) \ No newline at end of file diff --git a/src/dotnet/commands/dotnet-compile/README.md b/src/dotnet/commands/dotnet-compile/README.md deleted file mode 100644 index 2febd7cb10..0000000000 --- a/src/dotnet/commands/dotnet-compile/README.md +++ /dev/null @@ -1,79 +0,0 @@ -% DOTNET-COMPILE(1) -% Zlatko Knezevic zlakne@microsoft.com -% January 2016 - -# NAME -dotnet-compile -- Compiles source files for a single project to a binary format and saves to a target file. - -# SYNOPSIS -dotnet compile [--native] [--output] - [--build-base-path] [--framework] [--configuration] - [--output] [--arch] [--cpp] [-ilc-args] [--verbose] - -# DESCRIPTION -The compile command compiles source files from a single project to a binary file, either intermediate language (IL) byte code or native machine code, depending on the options provided. The default option is compilation to IL byte code, but may change in the future. Users who want to benefit from incremental builds and who want to compile both the project and its dependencies should use the dotnet-build(1) command. - -The result of compilation is by default an executable file that can be ran. Output files, are written to the child `bin` folder, which will be created if it doesn't exist. Files will be overwritten as needed. The temporary files that are created during compilation are placed in the child `obj` folder. - -The executables also require a special configuration section in project.json: - -```json -{ - "compilationOptions": { - "emitEntryPoint": true - } -} -``` - -The default native [--native] output is a native exe that conforms to the architecture of the underlying operating system (i.e. running on 64-bit OS will produce a native 64-bit exe). This can be overriden via the --arch switch and specifying the wanted architecture. The executable has a default extension of "" on Linux and OS X and ".exe" on Windows. The source must include a static void main entry point, or it is an error, unless otherwise specified in the project.json. The dynamic library [dylib] output option has the default extension of ".so" on Linux/UNIX, ".dynlib" on OS X and ".dll" on Windows. The static library [staticlib] option has the default extension of ".a" on Linux, UNIX and OS X and ".lib" on Windows. - -This command relies on the following artifacts: source files, project.json project file and the "lock" file (project.lock.json). Prior to invoking dotnet-compile, dotnet-restore(1) should be run to restore any dependencies that are needed for the application. - -# OPTIONS - -`-n, --native` - - Compiles source to native machine code, for the local machine. The default is a native executable. The default executable extension is no extension and ".exe" on Windows. - -`-b, --build-base-path ` - - Path where to drop the output produced during compile. By default, the binaries are dropped in the `bin` and `obj` directory in the directory where `project.json` files lives, that is, where the application lives. - -`-f, --framework ` - - Compile the application for the specified framework. If the framework is not specified, one specified in `project.json` will be used. - -`-c, --configuration ` - - Compile the application under the specified configuration. If not specified, the configuration will default to "Debug". - -`-o, --output filename` - - Specifies the filename to be used. By default, the resulting filename will be the same as the project name specified in `project.json`, if one exists, or the directory in which the source files reside. - -`--no-project-dependencies` - - Skips building cross-project references. The effect of this is that only the current project will be built. - -`-a, --arch` - - The architecture for which to compile. x64 only currently supported. - -`--ilc-args ` - - Specified parameters are passed through to ILC and are used by the engine when doing native compilation. - -`--cpp` - - Specify the C++ code generator to do native compilation of code instead of the default RyuJIT. - -`-v, --verbose` - - Prints verbose logging information, to follow the flow of execution of the command. - -`-h, --help` - - Show short help. - -# SEE ALSO -dotnet-restore(1), dotnet-publish(1), dotnet(1) diff --git a/src/dotnet/commands/dotnet-publish/README.md b/src/dotnet/commands/dotnet-publish/README.md index 32f17576bb..f4d57a6c1b 100644 --- a/src/dotnet/commands/dotnet-publish/README.md +++ b/src/dotnet/commands/dotnet-publish/README.md @@ -16,7 +16,7 @@ dotnet-publish [--framework] ## DESCRIPTION -`dotnet-publish` compiles the application, reads through its dependencies specified in `project.json` and publishes the resulting set of files to a directory. +`dotnet-publish` builds the application, reads through its dependencies specified in `project.json` and publishes the resulting set of files to a directory. Depending on the type of portable app, the directory contains the following: @@ -83,4 +83,4 @@ exist in the `project.json` `runtimes` node. ## SEE ALSO -dotnet-restore(1), dotnet-compile(1) +dotnet-restore(1), dotnet-build(1)