From 09ad260f28df803cf288cecd5aa681c81f7bfa13 Mon Sep 17 00:00:00 2001 From: Zlatko Knezevic Date: Wed, 10 Jun 2015 07:43:33 -0700 Subject: [PATCH] Fixing for comments in #1114 --- Documentation/README.md | 22 +++++++++++-------- Documentation/botr/method-descriptor.md | 4 ++-- Documentation/botr/ryujit-overview.md | 2 +- Documentation/botr/type-system.md | 2 +- Documentation/building/testing-with-corefx.md | 2 +- Documentation/dotnetcore-intro.md | 4 ---- .../get-dotnetcore-dnx-linux.md | 0 .../get-dotnetcore-dnx-osx.md | 0 .../get-dotnetcore-dnx-windows.md | 0 .../get-dotnetcore-windows.md | 0 .../clr-complus-conf-docgen.sh | 0 .../clr-configuration-knobs.md | 0 .../dotnet-filenames.md | 0 .../dotnet-standards.md | 0 .../{decoders => project-docs}/glossary.md | 0 .../jit-testing.md | 0 README.md | 2 +- 17 files changed, 19 insertions(+), 19 deletions(-) delete mode 100644 Documentation/dotnetcore-intro.md rename Documentation/{installing => install}/get-dotnetcore-dnx-linux.md (100%) rename Documentation/{installing => install}/get-dotnetcore-dnx-osx.md (100%) rename Documentation/{installing => install}/get-dotnetcore-dnx-windows.md (100%) rename Documentation/{installing => install}/get-dotnetcore-windows.md (100%) rename Documentation/{miscellaneous => project-docs}/clr-complus-conf-docgen.sh (100%) rename Documentation/{miscellaneous => project-docs}/clr-configuration-knobs.md (100%) rename Documentation/{decoders => project-docs}/dotnet-filenames.md (100%) rename Documentation/{miscellaneous => project-docs}/dotnet-standards.md (100%) rename Documentation/{decoders => project-docs}/glossary.md (100%) rename Documentation/{miscellaneous => project-docs}/jit-testing.md (100%) diff --git a/Documentation/README.md b/Documentation/README.md index 5cd69e7f82fa..d6b0e75a01f0 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -3,19 +3,23 @@ Documents Index This repo includes several documents that explain both high-level and low-level concepts about the .NET runtime. These are very useful for contributors, to get context that can be very difficult to acquire from just reading code. +Intro to .NET Core +================== + +.NET Core is a self-contained .NET runtime and framework that implements [ECMA 335](dotnet-standards.md). It can be (and has been) ported to multiple architectures and platforms. It support a variety of installation options, having no specific deployment requirements itself. + Learn about .NET Core ==================== -- [Brief Intro to .NET Core](dotnetcore-intro.md) - [[WIP] Official .NET Core Docs](http://dotnet.readthedocs.org) Get .NET Core ============= -- [Get .NET Core DNX SDK on Windows](installing/get-dotnetcore-dnx-windows.md) -- [Get .NET Core DNX SDK on OS X](installing/get-dotnetcore-dnx-osx.md) -- [Get .NET Core DNX SDK on Linux](installing/get-dotnetcore-dnx-linux.md) -- [Get .NET Core (Raw) on Windows](installing/get-dotnetcore-windows.md) +- [Get .NET Core DNX SDK on Windows](install/get-dotnetcore-dnx-windows.md) +- [Get .NET Core DNX SDK on OS X](install/get-dotnetcore-dnx-osx.md) +- [Get .NET Core DNX SDK on Linux](install/get-dotnetcore-dnx-linux.md) +- [Get .NET Core (Raw) on Windows](install/get-dotnetcore-windows.md) Project Docs ============ @@ -68,15 +72,15 @@ Book of the Runtime Decoder Rings ============= -- [.NET Core Glossary](decoders/glossary.md) -- [.NET Filename Encyclopedia](decoders/dotnet-filenames.md) +- [.NET Core Glossary](project-docs/glossary.md) +- [.NET Filename Encyclopedia](project-docs/dotnet-filenames.md) Other Information ================= - [CoreFX Repo documentation](https://github.com/dotnet/corefx/tree/master/Documentation) - [Porting to .NET Core](https://github.com/dotnet/corefx/blob/master/Documentation/support-dotnet-core-instructions.md) -- [.NET Standards (Ecma)](miscellaneous/dotnet-standards.md) -- [CLR Configuration Knobs](miscellaneous/clr-configuration-knobs.md) +- [.NET Standards (Ecma)](project-docs/dotnet-standards.md) +- [CLR Configuration Knobs](project-docs/clr-configuration-knobs.md) - [MSDN Entry for the CLR](http://msdn.microsoft.com/library/8bs2ecf4.aspx) - [Wikipedia Entry for the CLR](http://en.wikipedia.org/wiki/Common_Language_Runtime) diff --git a/Documentation/botr/method-descriptor.md b/Documentation/botr/method-descriptor.md index fec5a2661faa..ae548c432f14 100644 --- a/Documentation/botr/method-descriptor.md +++ b/Documentation/botr/method-descriptor.md @@ -50,11 +50,11 @@ P/Invoke methods. These are methods marked with DllImport attribute. **EEImpl** -Delegate methods whose implementation is provided by the runtime (Invoke, BeginInvoke, EndInvoke). See [ECMA 335 Partition II - Delegates](../miscellaneous/dotnet-standards.md). +Delegate methods whose implementation is provided by the runtime (Invoke, BeginInvoke, EndInvoke). See [ECMA 335 Partition II - Delegates](../project-docs/dotnet-standards.md). **Array** -Array methods whose implementation is provided by the runtime (Get, Set, Address). See [ECMA Partition II – Arrays](../miscellaneous/dotnet-standards.md). +Array methods whose implementation is provided by the runtime (Get, Set, Address). See [ECMA Partition II – Arrays](../project-docs/dotnet-standards.md). **ComInterop** diff --git a/Documentation/botr/ryujit-overview.md b/Documentation/botr/ryujit-overview.md index 9596a5efa3ac..95e89804244d 100644 --- a/Documentation/botr/ryujit-overview.md +++ b/Documentation/botr/ryujit-overview.md @@ -536,7 +536,7 @@ Below are some of the most useful `COMPLUS` variables. Where {method-list} is sp * `COMPLUS_JitTimeLogFile`={file name} – this specifies a log file to which timing information is written. * `COMPLUS_JitTimeLogCsv`={file name} – this specifies a log file to which summary timing information can be written, in CSV form. -See also: [CLR Configuration Knobs](../miscellaneous/clr-configuration-knobs.md) +See also: [CLR Configuration Knobs](../project-docs/clr-configuration-knobs.md) # Reading a JitDump diff --git a/Documentation/botr/type-system.md b/Documentation/botr/type-system.md index 4be4d61f96d3..ca5f23463a08 100644 --- a/Documentation/botr/type-system.md +++ b/Documentation/botr/type-system.md @@ -227,7 +227,7 @@ Major entry points are BuildMethodTable, LoadTypeHandleThrowing, CanCastTo\*, Ge Related Reading =============== -- [ECMA CLI Specification](../miscellaneous/dotnet-standards.md) +- [ECMA CLI Specification](../project-docs/dotnet-standards.md) - [Type Loader](type-loader.md) Book of the Runtime Chapter - [Virtual Stub Dispatch](virtual-stub-dispatch.md) Book of the Runtime Chapter - [MethodDesc](method-descriptor.md) Book of the Runtime Chapter diff --git a/Documentation/building/testing-with-corefx.md b/Documentation/building/testing-with-corefx.md index c1894a25f7e0..92b94b9d5ca1 100644 --- a/Documentation/building/testing-with-corefx.md +++ b/Documentation/building/testing-with-corefx.md @@ -7,7 +7,7 @@ In order to do this you need to create a file called `localpublish.props` under The contents of the file should look like this (make sure to update the version to the current version of the CoreCLR package used by CoreFx): + xmlns="http://schemas.microsoft.com/developer/msbuilding/2003"> Microsoft.DotNet.CoreCLR diff --git a/Documentation/dotnetcore-intro.md b/Documentation/dotnetcore-intro.md deleted file mode 100644 index 31b1575f8c69..000000000000 --- a/Documentation/dotnetcore-intro.md +++ /dev/null @@ -1,4 +0,0 @@ -Intro to .NET Core -================== - -.NET Core is a self-contained .NET runtime and framework that implements [ECMA 335](dotnet-standards.md). It can be (and has been) ported to multiple architectures and platforms. It support a variety of installation options, having no specific deployment requirements itself. diff --git a/Documentation/installing/get-dotnetcore-dnx-linux.md b/Documentation/install/get-dotnetcore-dnx-linux.md similarity index 100% rename from Documentation/installing/get-dotnetcore-dnx-linux.md rename to Documentation/install/get-dotnetcore-dnx-linux.md diff --git a/Documentation/installing/get-dotnetcore-dnx-osx.md b/Documentation/install/get-dotnetcore-dnx-osx.md similarity index 100% rename from Documentation/installing/get-dotnetcore-dnx-osx.md rename to Documentation/install/get-dotnetcore-dnx-osx.md diff --git a/Documentation/installing/get-dotnetcore-dnx-windows.md b/Documentation/install/get-dotnetcore-dnx-windows.md similarity index 100% rename from Documentation/installing/get-dotnetcore-dnx-windows.md rename to Documentation/install/get-dotnetcore-dnx-windows.md diff --git a/Documentation/installing/get-dotnetcore-windows.md b/Documentation/install/get-dotnetcore-windows.md similarity index 100% rename from Documentation/installing/get-dotnetcore-windows.md rename to Documentation/install/get-dotnetcore-windows.md diff --git a/Documentation/miscellaneous/clr-complus-conf-docgen.sh b/Documentation/project-docs/clr-complus-conf-docgen.sh similarity index 100% rename from Documentation/miscellaneous/clr-complus-conf-docgen.sh rename to Documentation/project-docs/clr-complus-conf-docgen.sh diff --git a/Documentation/miscellaneous/clr-configuration-knobs.md b/Documentation/project-docs/clr-configuration-knobs.md similarity index 100% rename from Documentation/miscellaneous/clr-configuration-knobs.md rename to Documentation/project-docs/clr-configuration-knobs.md diff --git a/Documentation/decoders/dotnet-filenames.md b/Documentation/project-docs/dotnet-filenames.md similarity index 100% rename from Documentation/decoders/dotnet-filenames.md rename to Documentation/project-docs/dotnet-filenames.md diff --git a/Documentation/miscellaneous/dotnet-standards.md b/Documentation/project-docs/dotnet-standards.md similarity index 100% rename from Documentation/miscellaneous/dotnet-standards.md rename to Documentation/project-docs/dotnet-standards.md diff --git a/Documentation/decoders/glossary.md b/Documentation/project-docs/glossary.md similarity index 100% rename from Documentation/decoders/glossary.md rename to Documentation/project-docs/glossary.md diff --git a/Documentation/miscellaneous/jit-testing.md b/Documentation/project-docs/jit-testing.md similarity index 100% rename from Documentation/miscellaneous/jit-testing.md rename to Documentation/project-docs/jit-testing.md diff --git a/README.md b/README.md index 5d477865a7c8..19f2fb0af50c 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Get .NET Core | |Linux |Windows |Mac OS X |FreeBSD | |---------------------|--------|--------|---------|---------| |Build from **Source**| [Instructions](Documentation/building/linux-instructions.md) | [Instructions](Documentation/building/windows-instructions.md) | [Instructions](Documentation/building/osx-instructions.md) | [Instructions](Documentation/building/freebsd-instructions.md) | -|Get **Binaries** | [DNX SDK](Documentation/installing/get-dotnetcore-dnx-linux.md)|[DNX SDK](Documentation/installing/get-dotnetcore-dnx-windows.md)
[Raw](Documentation/installing/get-dotnetcore-windows.md)|[DNX SDK](Documentation/installing/get-dotnetcore-dnx-osx.md)|| +|Get **Binaries** | [DNX SDK](Documentation/install/get-dotnetcore-dnx-linux.md)|[DNX SDK](Documentation/install/get-dotnetcore-dnx-windows.md)
[Raw](Documentation/install/get-dotnetcore-windows.md)|[DNX SDK](Documentation/install/get-dotnetcore-dnx-osx.md)|| Chat Room ---------