diff --git a/mk/docs.mk b/mk/docs.mk index 2a5a847d2a42..4c2c1243c65a 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/grammar.md b/src/doc/grammar.md index b4e023c20391..9124328b8eee 100644 --- a/src/doc/grammar.md +++ b/src/doc/grammar.md @@ -1,6 +1,4 @@ -# **This is a work in progress** - -% The Rust Grammar +% Grammar # Introduction diff --git a/src/doc/reference.md b/src/doc/reference.md index 1d618052e9f5..3223e2f26265 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