summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Lander <rlander@microsoft.com>2015-02-12 07:06:16 -0800
committerRich Lander <rlander@microsoft.com>2015-02-12 07:06:16 -0800
commit05f5c2e33ecb891b7824804bd8453a441efad409 (patch)
tree3fb0044cac9bff498ff143e89baff09edf3b5248
parent8c31f9e205ef93f93f953fcf7f64de7b7ec0d166 (diff)
parent44e4805e4f0ccdccb8b87a24cc256c523b799504 (diff)
downloadcoreclr-05f5c2e33ecb891b7824804bd8453a441efad409.tar.gz
coreclr-05f5c2e33ecb891b7824804bd8453a441efad409.tar.bz2
coreclr-05f5c2e33ecb891b7824804bd8453a441efad409.zip
Merge pull request #235 from richlander/master
Update documents
-rw-r--r--Documentation/index.md28
-rw-r--r--Documentation/stackwalking.md2
-rw-r--r--README.md18
3 files changed, 36 insertions, 12 deletions
diff --git a/Documentation/index.md b/Documentation/index.md
new file mode 100644
index 0000000000..139eda100c
--- /dev/null
+++ b/Documentation/index.md
@@ -0,0 +1,28 @@
+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.
+
+# Book of the Runtime
+
+- [Introduction to the Common Language Runtime](intro-to-clr.md)
+- [Mscorlib and Calling Into the Runtime](mscorlib.md)
+- [Stack Walking](stackwalking.md)
+- [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)
+
+# Links to other sources
+
+- [MSDN Entry for the CLR][clr](http://msdn.microsoft.com/en-us/library/8bs2ecf4(VS.71).aspx)
+- [Wikipedia Entry for the CLR](http://en.wikipedia.org/wiki/Common_Language_Runtime)
+- [ECMA Standard for the Common Language Infrastructure (CLI)](http://msdn.microsoft.com/en-us/netframework/aa569283.aspx)
+ - [Partition I Concepts and Architecture](http://download.microsoft.com/download/7/3/3/733AD403-90B2-4064-A81E-01035A7FE13C/MS%20Partition%20I.pdf)
+ - [Partition II Meta Data Definition and Semantics](http://download.microsoft.com/download/7/3/3/733AD403-90B2-4064-A81E-01035A7FE13C/MS%20Partition%20II.pdf)
+ - [Partition III CIL Instruction Set][cil-spec](http://download.microsoft.com/download/7/3/3/733AD403-90B2-4064-A81E-01035A7FE13C/MS%20Partition%20III.pdf)
+- [.NET Framework Design Guidelines](http://msdn.microsoft.com/en-us/library/ms229042.aspx)
diff --git a/Documentation/stackwalking.md b/Documentation/stackwalking.md
index d58fc439f5..e755b6225b 100644
--- a/Documentation/stackwalking.md
+++ b/Documentation/stackwalking.md
@@ -1,6 +1,6 @@
Stackwalking
---
-2008
+Author: Rudi Martin - 2008
The CLR makes heavy use of a technique known as stack walking (or stack crawling). This involves iterating the sequence of calls frames for a particular thread, from the most recent (the thread's current function) back down to the base of the stack.
diff --git a/README.md b/README.md
index a484559456..67ef399bfc 100644
--- a/README.md
+++ b/README.md
@@ -12,17 +12,17 @@ The coreclr repo contains the complete runtime implementation (called "CoreCLR")
The [.NET Core Libraries][corefx] repo contains the base class libraries, which provides data types and base functionality (ex: String, Collections, HttpClient) on top of CoreCLR. The two repos together make up .NET Core. The [.NET Core is Open Source][.NET Core oss] and [Introducing .NET Core][Introducing .NET Core] blog posts describes our .NET Core OSS strategy and road map in more detail.
+Want to chat with other members of the CoreCLR community?
+
+[![Join the chat at https://gitter.im/dotnet/coreclr](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/coreclr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
## Learn about CoreCLR
-Historically, new devs to the CLR team would be encouraged to read the "Book of the Runtime" (BotR) before making substative changes to the product. We have released the meaningful BotR chapters, for the same goal with new contributors.
+Historically, new devs to the CLR team would be encouraged to read the "Book of the Runtime" (BotR) before making substative changes to the product. We have released the meaningful BotR chapters and other documents, for the same goal with new contributors.
-- [Book of the Runtime FAQ](Documentation/botr-faq.md)
- [Introduction to the Common Language Runtime](Documentation/intro-to-clr.md)
-- [Mscorlib and Calling Into the Runtime](Documentation/mscorlib.md)
-- [Stack Walking](Documentation/stackwalking.md)
+- [Book of the Runtime](Documentation/index.md#book-of-the-runtime)
- [CLR Coding Guide](Documentation/clr-code-guide.md)
-- [.NET Core Glossary](Documentation/glossary.md)
-- [.NET Filename Encyclopedia](Documentation/dotnet-filenames.md)
-- More coming
+- [Documents Index](Documentation/index.md)
## How to Engage, Contribute and Provide Feedback
@@ -44,10 +44,6 @@ gist or starting a thread in the [.NET Foundation forums]. For broader topics, p
[.NET Foundation forums]: http://forums.dotnetfoundation.org/
-Want to chat with other members of the CoreCLR community?
-
-[![Join the chat at https://gitter.im/dotnet/coreclr](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/coreclr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
## CoreCLR Build Artifacts
The build for this repo will produce the following artifacts: