From 4cad56a6638df82449f26dc10220a27f1e37c6b6 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alexander=20K=C3=B6plinger?= Date: Thu, 12 Feb 2015 11:09:45 +0100 Subject: [PATCH] [docs] Headers should be surrounded by blank lines See markdownlint rule MD-022: https://github.com/mivok/markdownlint/blob/master/docs/RULES.md#md022---headers-should-be-surrounded-by-blank-lines --- Documentation/botr-faq.md | 1 + Documentation/clr-code-guide.md | 2 +- Documentation/index.md | 2 ++ Documentation/intro-to-clr.md | 1 + Documentation/mscorlib.md | 1 + Documentation/stackwalking.md | 3 ++- 6 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Documentation/botr-faq.md b/Documentation/botr-faq.md index fe09a12..824aa66 100644 --- a/Documentation/botr-faq.md +++ b/Documentation/botr-faq.md @@ -2,6 +2,7 @@ Book of the Runtime (BotR) FAQ === # What is the BotR? + The [Book of the Runtime](https://github.com/dotnet/coreclr#learn-about-coreclr) is a set of documents that describe components in the CLR and BCL. They are intended to focus more on architecture and invariants and not an annotated description of the codebase. It was originally created within Microsoft in ~ 2007, including this document. Developers were responsible to document their feature areas. This helped new devs joining the team and also helped share the product architecture across the team. diff --git a/Documentation/clr-code-guide.md b/Documentation/clr-code-guide.md index 0cdd004..e46f122 100644 --- a/Documentation/clr-code-guide.md +++ b/Documentation/clr-code-guide.md @@ -311,7 +311,7 @@ OBJECTREF's pointer mimicry isn't perfect. In certain cases, the checked build r compiles fine under retail but breaks under checked. The usual workaround is something like this: pv = (LPVOID)OBJECTREFToObject(o); - + ### How to know if a function can trigger a GC. The GC behavior of every function in the source base must be documented in its contract. Every function must have a contract that declares one of the following: diff --git a/Documentation/index.md b/Documentation/index.md index 08e7f05..8b9ecc9 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -11,9 +11,11 @@ This repo includes several documents that explain both high-level and low-level - [Book of the Runtime FAQ](botr-faq.md) # Coding Guides + - [CLR Coding Guide](clr-code-guide.md) # Glossary + - [.NET Core Glossary](glossary.md) - [.NET Filename Encyclopedia](dotnet-filenames.md) diff --git a/Documentation/intro-to-clr.md b/Documentation/intro-to-clr.md index 8df5b16..f7c76bd 100644 --- a/Documentation/intro-to-clr.md +++ b/Documentation/intro-to-clr.md @@ -1,5 +1,6 @@ Introduction to the Common Language Runtime (CLR) === + By Vance Morrison ([@vancem](https://github.com/vancem)) - 2007 What is the Common Language Runtime (CLR)? To put it succinctly: diff --git a/Documentation/mscorlib.md b/Documentation/mscorlib.md index 03cfcee..9bfa729 100644 --- a/Documentation/mscorlib.md +++ b/Documentation/mscorlib.md @@ -1,5 +1,6 @@ Mscorlib and Calling Into the Runtime === + Author: Brian Grunkemeyer ([@briangru](https://github.com/briangru)) - 2006 # Introduction diff --git a/Documentation/stackwalking.md b/Documentation/stackwalking.md index baf9e20..0eeada9 100644 --- a/Documentation/stackwalking.md +++ b/Documentation/stackwalking.md @@ -1,5 +1,6 @@ Stackwalking in the CLR ---- +=== + Author: Rudi Martin ([@Rudi-Martin](https://github.com/Rudi-Martin)) - 2008 The CLR makes heavy use of a technique known as stack walking (or stack crawling). This involves iterating the sequence of call frames for a particular thread, from the most recent (the thread's current function) back down to the base of the stack. -- 2.7.4