X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fstandards.texi;h=b95d930d36d13eda918bb7fb516bfb795e97068b;hb=4600899b8430f10a10e13761829bff41bc5ca902;hp=28bfc81f12979d93a542ead5b6662493e7874993;hpb=98c2fc1ab7d395bb92cf4a57233fe432539d26a9;p=pintos-anon diff --git a/doc/standards.texi b/doc/standards.texi index 28bfc81..b95d930 100644 --- a/doc/standards.texi +++ b/doc/standards.texi @@ -1,4 +1,4 @@ -@node Coding Standards, , Multilevel Feedback Scheduling, Top +@node Coding Standards, Project Documentation, Multilevel Feedback Scheduling, Top @appendix Coding Standards All of you should have taken a class like CS 107, so we expect you to @@ -21,6 +21,8 @@ our coding standards will affect our grading. @menu * Coding Style:: * Conditional Compilation:: +* C99:: +* Unsafe String Functions:: @end menu @node Coding Style @@ -39,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. +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 @@ -63,9 +70,15 @@ There are a few exceptions: @itemize @bullet @item -Project 1 has a few parts that we must be able to turn on and off via -conditional compilation. You must use the macros we specify for those -parts. +Problem 1-2, @code{thread_join()}. Some other code expects +@code{THREAD_JOIN_IMPLEMENTED} to be defined once you've implemented +this function. + +@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 +specify for that part. @xref{Problem 1-4 Advanced Scheduler}, for +details. @item Code written for extra credit may be included conditionally. If the @@ -132,7 +145,7 @@ the C compiler concatenates adjacent string literals: #include @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