From f64d91211fdf483bd199448e8baa272381ead48e Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Fri, 13 Feb 2015 18:00:00 -0500 Subject: [PATCH] Generate grammar.html and link to it from the reference. Fixes #19278 --- mk/docs.mk | 2 +- src/doc/reference.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/mk/docs.mk b/mk/docs.mk index 2a5a847d2a4..4c2c1243c65 100644 --- a/mk/docs.mk +++ b/mk/docs.mk @@ -27,7 +27,7 @@ ###################################################################### DOCS := index intro tutorial complement-bugreport \ complement-lang-faq complement-design-faq complement-project-faq \ - rustdoc reference + rustdoc reference grammar # Legacy guides, preserved for a while to reduce the number of 404s DOCS += guide-crates guide-error-handling guide-ffi guide-macros guide \ diff --git a/src/doc/reference.md b/src/doc/reference.md index 9c51f6bad6f..c0af6affe8f 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -5,9 +5,7 @@ This document is the primary reference for the Rust programming language. It provides three kinds of material: - - Chapters that formally define the language grammar and, for each - construct, informally describe its semantics and give examples of its - use. + - Chapters that informally describe each language construct and their use. - Chapters that informally describe the memory model, concurrency model, runtime services, linkage model and debugging facilities. - Appendix chapters providing rationale and references to languages that @@ -23,8 +21,11 @@ separately by extracting documentation attributes from their source code. Many of the features that one might expect to be language features are library features in Rust, so what you're looking for may be there, not here. +You may also be interested in the [grammar]. + [book]: book/index.html [standard]: std/index.html +[grammar]: grammar.html # Notation