projects
/
pintos-anon
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
51878ce
)
Make requirements consistent with doc template wording.
author
Ben Pfaff
<blp@cs.stanford.edu>
Fri, 7 Jul 2006 20:54:50 +0000
(20:54 +0000)
committer
Ben Pfaff
<blp@cs.stanford.edu>
Fri, 7 Jul 2006 20:54:50 +0000
(20:54 +0000)
doc/intro.texi
patch
|
blob
|
history
diff --git
a/doc/intro.texi
b/doc/intro.texi
index 57327781f913b8cef75d1c7733e33240373c1d43..ede0a69b58fccc85b6fc9a6cc33fb08dffc678ef 100644
(file)
--- a/
doc/intro.texi
+++ b/
doc/intro.texi
@@
-492,7
+492,8
@@
make your code self-consistent at the very least. There should not be a
patchwork of different styles that makes it obvious that three different
people wrote the code. Use horizontal and vertical white space to make
code readable. Add a brief comment on every structure, structure
patchwork of different styles that makes it obvious that three different
people wrote the code. Use horizontal and vertical white space to make
code readable. Add a brief comment on every structure, structure
-member, global or static variable, and function definition. Update
+member, global or static variable, typedef, enumeration, and function
+definition. Update
existing comments as you modify code. Don't comment out or use the
preprocessor to ignore blocks of code (instead, remove it entirely).
Use assertions to document key invariants. Decompose code into
existing comments as you modify code. Don't comment out or use the
preprocessor to ignore blocks of code (instead, remove it entirely).
Use assertions to document key invariants. Decompose code into