summaryrefslogtreecommitdiff
path: root/Documentation/coding-guidelines
diff options
context:
space:
mode:
authorOmair Majid <omajid@redhat.com>2017-03-20 18:12:33 -0400
committerOmair Majid <omajid@redhat.com>2017-03-20 18:12:33 -0400
commit765f28934dc3c47e0f3658a818bcc04d3c71c9ef (patch)
tree2b702c638ef65a3c87c0b9d01520b3e0f4992863 /Documentation/coding-guidelines
parent281da0a152ff5dc65b4bebcc95d19ec8e4a4508e (diff)
downloadcoreclr-765f28934dc3c47e0f3658a818bcc04d3c71c9ef.tar.gz
coreclr-765f28934dc3c47e0f3658a818bcc04d3c71c9ef.tar.bz2
coreclr-765f28934dc3c47e0f3658a818bcc04d3c71c9ef.zip
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
Diffstat (limited to 'Documentation/coding-guidelines')
-rw-r--r--Documentation/coding-guidelines/EventLogging.md2
-rw-r--r--Documentation/coding-guidelines/cross-platform-performance-and-eventing.md2
2 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/coding-guidelines/EventLogging.md b/Documentation/coding-guidelines/EventLogging.md
index a53d6e9844..8ba84d7001 100644
--- a/Documentation/coding-guidelines/EventLogging.md
+++ b/Documentation/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/Documentation/coding-guidelines/cross-platform-performance-and-eventing.md b/Documentation/coding-guidelines/cross-platform-performance-and-eventing.md
index f332724478..37a3135f93 100644
--- a/Documentation/coding-guidelines/cross-platform-performance-and-eventing.md
+++ b/Documentation/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.