Mention style for references.

[pintos-anon] / doc / standards.texi

diff --git a/doc/standards.texi b/doc/standards.texi
index 60aa21aa8afcaf82c348618227d3b51a83be6c0f..b95d930d36d13eda918bb7fb516bfb795e97068b 100644 (file)
--- a/doc/standards.texi
+++ b/doc/standards.texi
@@ -41,6 +41,11 @@ them too, especially chapter 5, ``Making the Best Use of C.''  Using a
 different style won't cause actual problems, but it's ugly to see
 gratuitous differences in style from one function to another.
 
 different style won't cause actual problems, but it's ugly to see
 gratuitous differences in style from one function to another.
 

+Pintos comments sometimes refer to outside standards or
+specifications by writing a name inside square brackets, like this:
+@code{[IA32-v3]}.  These names refer to the reference names used in
+this documentation (@pxref{References}).
+

 @node Conditional Compilation
 @section Conditional Compilation
 
 @node Conditional Compilation
 @section Conditional Compilation
 


@@ -71,7 +76,7 @@ this function.
 
 @item
 Problem 1-4, the advanced scheduler.  We must be able to turn this on
 
 @item
 Problem 1-4, the advanced scheduler.  We must be able to turn this on

-and off with a compile time directive.  You must use the macro name we
+and off with a compile-time directive.  You must use the macro name we

 specify for that part.  @xref{Problem 1-4 Advanced Scheduler}, for
 details.
 
 specify for that part.  @xref{Problem 1-4 Advanced Scheduler}, for
 details.
 


@@ -140,7 +145,7 @@ the C compiler concatenates adjacent string literals:
 #include <inttypes.h>
 @dots{}
 int32_t value = @dots{};
 #include <inttypes.h>
 @dots{}
 int32_t value = @dots{};

-printf ("value=%08"PRId32"\n");
+printf ("value=%08"PRId32"\n", value);

 @end example
 @noindent
 The @samp{%} is not supplied by the @code{PRI} macros.  As shown
 @end example
 @noindent
 The @samp{%} is not supplied by the @code{PRI} macros.  As shown