X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fstandards.texi;h=a1c70a47961a69baac2f0bfe906c15870c88677d;hb=58a5b122cd16f9371104815c308e69f668647c61;hp=20e27a4463faae6d6bc12d2e801cbf095049dfb7;hpb=fbe57c81fd87acfef431c5f34f0fc84fe1841f18;p=pintos-anon diff --git a/doc/standards.texi b/doc/standards.texi index 20e27a4..a1c70a4 100644 --- a/doc/standards.texi +++ b/doc/standards.texi @@ -42,6 +42,8 @@ different style won't cause actual problems, but it's ugly to see gratuitous differences in style from one function to another. If your code is too ugly, it will cost you points. +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: @code{[IA32-v3]}. These names refer to the reference names used in @@ -50,7 +52,9 @@ this documentation (@pxref{References}). 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 compilation directive, because that makes the resulting code hard to -read. If you're worried about +read. We're only going to do a compile in the directory for the current +project, so you don't need to make sure that the previous projects also +compile. @node Conditional Compilation @section Conditional Compilation @@ -76,14 +80,9 @@ There are a few exceptions: @itemize @bullet @item -Problem 1-2, @func{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 +Problem 1-3, 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 +specify for that part. @xref{Problem 1-3 Advanced Scheduler}, for details. @item @@ -205,7 +204,7 @@ terminator and it has performance problems besides. Again, use @func{strlcpy}. @item strcat -Same issue as @func{strcpy}, but substitute @func{strlcat}. +Same issue as @func{strcpy}. Use @func{strlcat} instead. Again, refer to comments in its source code in @code{lib/string.c} for documentation.