From 737c5098360e2d94ad514e77811bb9e65e07aec0 Mon Sep 17 00:00:00 2001 From: Omair Majid Date: Mon, 20 Mar 2017 18:12:33 -0400 Subject: [PATCH] Fix markdown headings GitHub recently changed how atx headings (beginning with `#`) are rendered. A space is now required between `#` and the following text for the heading to be recognized. Update headings in the docs to match the expected format. See https://github.github.com/gfm/#atx-headings Commit migrated from https://github.com/dotnet/coreclr/commit/765f28934dc3c47e0f3658a818bcc04d3c71c9ef --- docs/coreclr/botr/README.md | 2 +- docs/coreclr/building/debugging-instructions.md | 2 +- docs/coreclr/building/windows-instructions.md | 16 ++++++------- docs/coreclr/coding-guidelines/EventLogging.md | 2 +- .../cross-platform-performance-and-eventing.md | 2 +- .../project-docs/linux-performance-tracing.md | 20 ++++++++--------- docs/coreclr/project-docs/profiling-api-status.md | 26 +++++++++++----------- docs/coreclr/workflow/IssuesFeedbackEngagement.md | 2 +- docs/coreclr/workflow/RunningTests.md | 2 +- 9 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/coreclr/botr/README.md b/docs/coreclr/botr/README.md index db4ffc1..99e4274 100644 --- a/docs/coreclr/botr/README.md +++ b/docs/coreclr/botr/README.md @@ -1,5 +1,5 @@ -#The Book of the Runtime +# The Book of the Runtime Welcome to the Book of the Runtime (BOTR) for the .NET Runtime. This contains a collection of articles about the non-trivial internals of the .NET Runtime. Its diff --git a/docs/coreclr/building/debugging-instructions.md b/docs/coreclr/building/debugging-instructions.md index 4c33f9a..72f198b 100644 --- a/docs/coreclr/building/debugging-instructions.md +++ b/docs/coreclr/building/debugging-instructions.md @@ -89,7 +89,7 @@ This is the full list of commands currently supported by SOS. LLDB is case-sensi HistObjFind (histobjfind) HistClear (histclear) -###Aliases### +### Aliases ### By default you can reach all the SOS commands by using: _sos [command\_name]_ However the common commands have been aliased so that you don't need the SOS prefix: diff --git a/docs/coreclr/building/windows-instructions.md b/docs/coreclr/building/windows-instructions.md index b89fa2c..f909a9a 100644 --- a/docs/coreclr/building/windows-instructions.md +++ b/docs/coreclr/building/windows-instructions.md @@ -4,7 +4,7 @@ Build CoreCLR on Windows These instructions will lead you through building CoreCLR. ---------------- -#Environment +# Environment You must install several components to build the CoreCLR and CoreFX repos. These instructions were tested on Windows 7+. @@ -48,7 +48,7 @@ For Visual Studio 2017: Visual Studio Express is not supported. -##CMake +## CMake The CoreCLR repo build has been validated using CMake 3.7.2 @@ -58,7 +58,7 @@ The CoreCLR repo build has been validated using CMake 3.7.2 following the instructions at [Adding to the Default PATH variable](#adding-to-the-default-path-variable) -##Python +## Python Python is used in the build system. We are currently using python 2.7.9, although any recent (2.4+) version of Python should work, including Python 3. @@ -67,7 +67,7 @@ any recent (2.4+) version of Python should work, including Python 3. The installation script has a check box to do this, but you can do it yourself after the fact following the instructions at [Adding to the Default PATH variable](#adding-to-the-default-path-variable) -##Git +## Git For actual user operations, it is often more convinient to use the GIT features built into Visual Studio 2015. However the CoreCLR and the tests use the GIT command line utilities directly so you need to install them @@ -78,20 +78,20 @@ for these to work properly. You can get it from The installation script has a check box to do this, but you can do it yourself after the fact following the instructions at [Adding to the Default PATH variable](#adding-to-the-default-path-variable) -##PowerShell +## PowerShell PowerShell is used in the build system. Ensure that it is accessible via the PATH environment variable. Typically this is %SYSTEMROOT%\System32\WindowsPowerShell\v1.0\. Powershell version must be 3.0 or higher. This should be the case for Windows 8 and later builds. - Windows 7 SP1 can install Powershell version 4 [here](https://www.microsoft.com/en-us/download/details.aspx?id=40855). -##DotNet Core SDK +## DotNet Core SDK While not strictly needed to build or tests the .NET Core repository, having the .NET Core SDK installed lets you use the dotnet.exe command to run .NET Core applications in the 'normal' way. We use this in the [Using Your Build](Documentation/workflow/UsingYourBuild.md) instructions. Visual Studio 2015 (update 3) should have installed the .NET Core SDK, but in case it did not you can get it from the [Installing the .Net Core SDK](https://www.microsoft.com/net/core) page. -##Adding to the default PATH variable +## Adding to the default PATH variable The commands above need to be on your command lookup path. Some installers will automatically add them to the path as part of installation, but if not here is how you can do it. @@ -106,7 +106,7 @@ and select the 'Path' variable in the 'System variables' (if you want to change to change it for the currnet user). Simply edit the PATH variable's value and add the directory (with a semicolon separator). ------------------------------------- -#Building +# Building Once all the necessary tools are in place, building is trivial. Simply run build build.cmd script that lives at the base of the repository. diff --git a/docs/coreclr/coding-guidelines/EventLogging.md b/docs/coreclr/coding-guidelines/EventLogging.md index a53d6e9..8ba84d7 100644 --- a/docs/coreclr/coding-guidelines/EventLogging.md +++ b/docs/coreclr/coding-guidelines/EventLogging.md @@ -1,6 +1,6 @@ # CoreClr Event Logging Design -##Introduction +## Introduction Event Logging is a mechanism by which CoreClr can provide a variety of information on it's state. This Logging works by inserting explicit logging calls by the developer within the VM . The Event Logging mechanism is largely based on [ETW- Event Tracing For Windows](https://msdn.microsoft.com/en-us/library/windows/desktop/bb968803(v=vs.85).aspx) diff --git a/docs/coreclr/coding-guidelines/cross-platform-performance-and-eventing.md b/docs/coreclr/coding-guidelines/cross-platform-performance-and-eventing.md index f332724..37a3135f 100644 --- a/docs/coreclr/coding-guidelines/cross-platform-performance-and-eventing.md +++ b/docs/coreclr/coding-guidelines/cross-platform-performance-and-eventing.md @@ -1,6 +1,6 @@ # .NET Cross-Plat Performance and Eventing Design -##Introduction +## Introduction As we bring up CoreCLR on the Linux and OS X platforms, it’s important that we determine how we’ll measure and analyze performance on these platforms. On Windows we use an event based model that depends on ETW, and we have a good amount of tooling that builds on this approach. Ideally, we can extend this model to Linux and OS X and re-use much of the Windows tooling. diff --git a/docs/coreclr/project-docs/linux-performance-tracing.md b/docs/coreclr/project-docs/linux-performance-tracing.md index 93d63b4..c9d66fa 100644 --- a/docs/coreclr/project-docs/linux-performance-tracing.md +++ b/docs/coreclr/project-docs/linux-performance-tracing.md @@ -3,13 +3,13 @@ Performance Tracing on Linux When a performance problem is encountered on Linux, these instructions can be used to gather detailed information about what was happening on the machine at the time of the performance problem. -#Required Tools# +# Required Tools # - **perfcollect**: Bash script that automates data collection. - Available at . - **PerfView**: Windows-based performance tool that can also analyze trace files collected with Perfcollect. - Available at . -#Preparing Your Machine# +# Preparing Your Machine # Follow these steps to prepare your machine to collect a performance trace. 1. Download Perfcollect. @@ -30,7 +30,7 @@ Follow these steps to prepare your machine to collect a performance trace. > sudo ./perfcollect install > ``` -#Collecting a Trace# +# Collecting a Trace # 1. Have two shell windows available - one for controlling tracing, referred to as **[Trace]**, and one for running the application, referred to as **[App]**. 2. **[App]** Setup the application shell - this enables tracing configuration inside of CoreCLR. @@ -81,7 +81,7 @@ Follow these steps to prepare your machine to collect a performance trace. The compressed trace file is now stored in the current working directory. -#Collecting in a Docker Container# +# Collecting in a Docker Container # Perfcollect can be used to collect data for an application running inside a Docker container. The main thing to know is that collecting a trace requires elevated privileges because the [default seccomp profile](https://docs.docker.com/engine/security/seccomp/) blocks a required syscall - perf_events_open. In order to use the instructions in this document to collect a trace, spawn a new shell inside the container that is privileged. @@ -94,7 +94,7 @@ Even though the application hosted in the container isn't privileged, this new s If you want to try tracing in a container, we've written a [demo Dockerfile](https://raw.githubusercontent.com/dotnet/corefx-tools/master/src/performance/perfcollect/docker-demo/Dockerfile) that installs all of the performance tracing pre-requisites, sets the environment up for tracing, and starts a sample CPU-bound app. -#Filtering# +# Filtering # Filtering is implemented on Windows through the latest mechanisms provided with the [EventSource](https://msdn.microsoft.com/en-us/library/system.diagnostics.tracing.eventsource(v=vs.110).aspx) class. On Linux those mechanisms are not available yet. Instead, there are two environment variables that exist just on linux to do some basic filtering. @@ -104,10 +104,10 @@ On Linux those mechanisms are not available yet. Instead, there are two environm Setting one or both of these variables will only enable collecting events that contain the name you specify as a substring. Strings are treated as case insensitive. -#Viewing a Trace# +# Viewing a Trace # Traces are best viewed using PerfView on Windows. Note that we're currently looking into porting the analysis pieces of PerfView to Linux so that the entire investigation can occur on Linux. -##Open the Trace File## +## Open the Trace File ## 1. Copy the trace.zip file from Linux to a Windows machine. 2. Download PerfView from . 3. Run PerfView.exe @@ -116,7 +116,7 @@ Traces are best viewed using PerfView on Windows. Note that we're currently loo > PerfView.exe > ``` -##Select a View## +## Select a View ## PerfView will display the list of views that are supported based on the data contained in the trace file. - For CPU investigations, choose **CPU stacks**. @@ -126,10 +126,10 @@ PerfView will display the list of views that are supported based on the data con For more details on how to interpret views in PerfView, see help links in the view itself, or from the main window in PerfView choose **Help->Users Guide**. -#Extra Information# +# Extra Information # This information is not strictly required to collect and analyze traces, but is provided for those who are interested. -##Prerequisites## +## Prerequisites ## Perfcollect will alert users to any prerequisites that are not installed and offer to install them. Prerequisites can be installed automatically by running: >```bash diff --git a/docs/coreclr/project-docs/profiling-api-status.md b/docs/coreclr/project-docs/profiling-api-status.md index a1f2f17..c689eae 100644 --- a/docs/coreclr/project-docs/profiling-api-status.md +++ b/docs/coreclr/project-docs/profiling-api-status.md @@ -1,10 +1,10 @@ -#Status of CoreCLR Profiler APIs +# Status of CoreCLR Profiler APIs The notes below will help you determine what profiling APIs are safe to use. The .NET Core project started with the codebase from the desktop CoreCLR/Silverlight so all the profiler APIs present there are also present in the code here. However that doesn't automatically imply that they are all working or being actively tested right now. Our goal is to eventually have everything tested and working across all the supported OSes. As we make progress we'll document it here. If you want to use APIs that we haven't tested yet you are welcome to do so, but you need to do your own testing to determine whether they work. If you do test APIs we haven't gotten to yet, we hope you'll add a note below in the Community Tested API section so that everyone can benefit. -#Microsoft Tested APIs: +# Microsoft Tested APIs: -###Windows +### Windows * ICorProfilerCallback: * `Initialize` @@ -34,12 +34,12 @@ The notes below will help you determine what profiling APIs are safe to use. The \* Instrumentation APIs have not been tested on assemblies compiled with Ready2Run technology. Ready2Run is currently used for all Framework assemblies. -###Linux -###OS X +### Linux +### OS X -#Community Tested APIs (please include GitHub handle) +# Community Tested APIs (please include GitHub handle) -###Windows +### Windows * IProfilerCallback * ModuleLoadStarted (noahfalk on behalf of one of our vendors) * JITCompilationStarted (noahfalk on behalf of one of our vendors) @@ -51,12 +51,12 @@ The notes below will help you determine what profiling APIs are safe to use. The * IMetaDataAssemblyEmit * DefineAssemblyRef (noahfalk on behalf of one of our vendors) -###Linux -###OS X +### Linux +### OS X -#APIs definitely known not to work yet -###Windows -###Linux +# APIs definitely known not to work yet +### Windows +### Linux * ICorProfilerInfo: * `SetEnterLeaveFunctionHooks` @@ -68,7 +68,7 @@ The notes below will help you determine what profiling APIs are safe to use. The * `COR_PRF_USE_PROFILE_IMAGES` * `COR_PRF_REQUIRE_PROFILE_IMAGE` -###OS X +### OS X * ICorProfilerInfo: * `SetEnterLeaveFunctionHooks` diff --git a/docs/coreclr/workflow/IssuesFeedbackEngagement.md b/docs/coreclr/workflow/IssuesFeedbackEngagement.md index f83b2b6..4346ed9 100644 --- a/docs/coreclr/workflow/IssuesFeedbackEngagement.md +++ b/docs/coreclr/workflow/IssuesFeedbackEngagement.md @@ -16,7 +16,7 @@ Before you log a new issue, you should try using the search tool on the issue pa If you want to ask a question, or want wider discussion (to see if others share you issue), we encourage you to start a thread in the [.NET Foundation forums](http://forums.dotnetfoundation.org/). -###Chat with the CoreCLR Community +### Chat with the CoreCLR Community For more real-time feedback you can also start a chat session by clicking on the icons below. diff --git a/docs/coreclr/workflow/RunningTests.md b/docs/coreclr/workflow/RunningTests.md index 0cf84be..65957f4 100644 --- a/docs/coreclr/workflow/RunningTests.md +++ b/docs/coreclr/workflow/RunningTests.md @@ -1,5 +1,5 @@ -#Running .NET Core Tests +# Running .NET Core Tests TODO - Incomplete. -- 2.7.4