Updated to use Bochs 2.6.11
[pintos-anon] / doc / standards.texi
index fbd673ae58df14ffb2c24488a892842892013264..7d30a4b4cfbe1c218a6390f752c4fb16ff484364 100644 (file)
@@ -1,12 +1,7 @@
-@node Coding Standards, Project Documentation, 4.4BSD Scheduler, Top
+@node Coding Standards
 @appendix Coding Standards
 
 @appendix Coding Standards
 
-All of you should have taken a class like CS 107, so we expect you to be
-familiar with some set of coding standards such as
-@uref{http://www.stanford.edu/class/cs140/projects/misc/CodingStandards.pdf,
-, CS 107 Coding Standards}. Even if you've taken 107, we recommend
-reviewing that document.  We expect code at the ``Peer-Review Quality''
-level described there.
+@localcodingstandards{}
 
 Our standards for coding are most important for grading.  We want to
 stress that aside from the fact that we are explicitly basing part of
 
 Our standards for coding are most important for grading.  We want to
 stress that aside from the fact that we are explicitly basing part of
@@ -44,8 +39,8 @@ Please limit C source file lines to at most 79 characters long.
 
 Pintos comments sometimes refer to external standards or
 specifications by writing a name inside square brackets, like this:
 
 Pintos comments sometimes refer to external 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}).
+@code{[IA32-v3a]}.  These names refer to the reference names used in
+this documentation (@pxref{Bibliography}).
 
 If you remove existing Pintos code, please delete it from your source
 file entirely.  Don't just put it into a comment or a conditional
 
 If you remove existing Pintos code, please delete it from your source
 file entirely.  Don't just put it into a comment or a conditional
@@ -156,7 +151,7 @@ A few of the string functions declared in the standard
 The worst offenders are intentionally not included in the Pintos C
 library:
 
 The worst offenders are intentionally not included in the Pintos C
 library:
 
-@table @func
+@table @code
 @item strcpy
 When used carelessly this function can overflow the buffer reserved
 for its output string.  Use @func{strlcpy} instead.  Refer to
 @item strcpy
 When used carelessly this function can overflow the buffer reserved
 for its output string.  Use @func{strlcpy} instead.  Refer to