Code index

[mark-i-m]

One thing that could be helpful is an index of important data structures, functions, methods, traits, etc in the compiler. I propose we add a chapter after the glossary with a big table (sorted alphabetically by item name) that looks something like this:

Item	Kind	Short description	Chapter	Declaration
foo	function	used by the parser to keep track bar	Parsing	src/libsyntax/foo.rs

TODO:

• TyCtxt (Start a code index #55)
• Ty (Add the contents of the typeck READMEs #85)
• DefId, HirId, NodeId, BodyId (A few more data structures to the code index #153 )
• CodeMap (Add info about CodeMap for #50 #69)
• StringReader (Add info about StringReader for #50 #72)
• ParseSess (Add info about ParseSess for code index #50 #68)
• Crate (Rustc Driver Chapter #76)
• TokenStream (A few more data structures to the code index #153)
• Rib (A few more data structures to the code index #153)
• ParamEnv (A few more data structures to the code index #153)
• TraitRef (A few more data structures to the code index #153)
• Span (Add info about emitting lints and errors #139)
• P<T> (as mentioned in Add to definition of P<T> type to Appendix D: Code Index #182) (Add P<T> to the code index #275)
• FileMap
• Parser

[mark-i-m]

A good first step on this would be to crawl the existing chapters and look for data structures that are explicitly mentioned.

[mark-i-m]

I'm going to go ahead and close this issue, as it doesn't seem to be useful any more...