Skip to content

Commit

Permalink
[docs] Headers should be surrounded by blank lines
Browse files Browse the repository at this point in the history
  • Loading branch information
akoeplinger committed Feb 12, 2015
1 parent ab59f47 commit 4cad56a
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 2 deletions.
1 change: 1 addition & 0 deletions Documentation/botr-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/clr-code-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions Documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
1 change: 1 addition & 0 deletions Documentation/intro-to-clr.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions Documentation/mscorlib.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Mscorlib and Calling Into the Runtime
===

Author: Brian Grunkemeyer ([@briangru](https://github.com/briangru)) - 2006

# Introduction
Expand Down
3 changes: 2 additions & 1 deletion Documentation/stackwalking.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 4cad56a

Please sign in to comment.