about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2017-10-04 22:38:22 -0700
committerKartik K. Agaram <vc@akkartik.com>2017-10-04 22:38:22 -0700
commit36f616b5c011e32e4a8be1a4864f81e11424de89 (patch)
treeefacd252ae493f3d63b5aa82df49bc3cb138c6ed
parent984a6321ad3dd5a20797cbd8cba800081bf56ad4 (diff)
downloadmu-36f616b5c011e32e4a8be1a4864f81e11424de89.tar.gz
4010
-rw-r--r--000organization.cc32
-rw-r--r--html/000organization.cc.html30
2 files changed, 31 insertions, 31 deletions
diff --git a/000organization.cc b/000organization.cc
index b795d8ab..d9f072f9 100644
--- a/000organization.cc
+++ b/000organization.cc
@@ -79,14 +79,14 @@
 //:
 //: This 'subsetting guarantee' ensures that this directory contains a
 //: cleaned-up narrative of the evolution of this codebase. Organizing
-//: autobiographically allows a newcomer to rapidly orient himself, reading the
-//: first few files to understand a simple gestalt of a program's core purpose
-//: and features, and later gradually working his way through other features as
-//: the need arises.
-//:
-//: Programmers shouldn't need to understand everything about a program to hack
-//: on it. But they shouldn't be prevented from a thorough understanding of
-//: each aspect either. The goal of layers is to reward curiosity.
+//: autobiographically allows a newcomers to rapidly orient themselves,
+//: reading the first few files to understand a simple gestalt of a program's
+//: core purpose and features, and later gradually working their way through
+//: other features as the need arises.
+//:
+//: Programmers shouldn't need to understand everything about a program to
+//: hack on it. But they shouldn't be prevented from a thorough understanding
+//: of each aspect either. The goal of layers is to reward curiosity.
 
 // Includes
 // End Includes
@@ -94,19 +94,19 @@
 // Types
 // End Types
 
-// Prototypes are auto-generated in the 'build' script; define your functions
-// in any order. Just be sure to declare each function header all on one line.
-// Our auto-generation scripts are too minimal and simple-minded to handle
-// anything else.
+// Function prototypes are auto-generated in the 'build' script; define your
+// functions in any order. Just be sure to declare each function header all on
+// one line, ending with the '{'. Our auto-generation scripts are too minimal
+// and simple-minded to handle anything else.
 #include "function_list"  // by convention, files ending with '_list' are auto-generated
 
 // Globals
 //
 // All statements in this section should always define a single variable on a
 // single line. The 'build' script will simple-mindedly auto-generate extern
-// declarations for them. Don't forget to define (not just declare) constants
-// with extern linkage in this section, since C++ global constants have
-// internal linkage by default.
+// declarations for them. Remember to define (not just declare) constants with
+// extern linkage in this section, since C++ global constants have internal
+// linkage by default.
 //
 // End Globals
 
@@ -124,7 +124,7 @@ int main(int argc, char* argv[]) {
 // Unit Tests
 // End Unit Tests
 
-//: our first directive; will move the include above the program
+//: our first directive; insert the following header at the start of the program
 :(before "End Includes")
 #include <stdlib.h>
 
diff --git a/html/000organization.cc.html b/html/000organization.cc.html
index de53adce..9ab0d4f1 100644
--- a/html/000organization.cc.html
+++ b/html/000organization.cc.html
@@ -138,14 +138,14 @@ if ('onhashchange' in window) {
 <span id="L79" class="LineNr"> 79 </span><span class="Comment">//:</span>
 <span id="L80" class="LineNr"> 80 </span><span class="Comment">//: This 'subsetting guarantee' ensures that this directory contains a</span>
 <span id="L81" class="LineNr"> 81 </span><span class="Comment">//: cleaned-up narrative of the evolution of this codebase. Organizing</span>
-<span id="L82" class="LineNr"> 82 </span><span class="Comment">//: autobiographically allows a newcomer to rapidly orient himself, reading the</span>
-<span id="L83" class="LineNr"> 83 </span><span class="Comment">//: first few files to understand a simple gestalt of a program's core purpose</span>
-<span id="L84" class="LineNr"> 84 </span><span class="Comment">//: and features, and later gradually working his way through other features as</span>
-<span id="L85" class="LineNr"> 85 </span><span class="Comment">//: the need arises.</span>
+<span id="L82" class="LineNr"> 82 </span><span class="Comment">//: autobiographically allows a newcomers to rapidly orient themselves,</span>
+<span id="L83" class="LineNr"> 83 </span><span class="Comment">//: reading the first few files to understand a simple gestalt of a program's</span>
+<span id="L84" class="LineNr"> 84 </span><span class="Comment">//: core purpose and features, and later gradually working their way through</span>
+<span id="L85" class="LineNr"> 85 </span><span class="Comment">//: other features as the need arises.</span>
 <span id="L86" class="LineNr"> 86 </span><span class="Comment">//:</span>
-<span id="L87" class="LineNr"> 87 </span><span class="Comment">//: Programmers shouldn't need to understand everything about a program to hack</span>
-<span id="L88" class="LineNr"> 88 </span><span class="Comment">//: on it. But they shouldn't be prevented from a thorough understanding of</span>
-<span id="L89" class="LineNr"> 89 </span><span class="Comment">//: each aspect either. The goal of layers is to reward curiosity.</span>
+<span id="L87" class="LineNr"> 87 </span><span class="Comment">//: Programmers shouldn't need to understand everything about a program to</span>
+<span id="L88" class="LineNr"> 88 </span><span class="Comment">//: hack on it. But they shouldn't be prevented from a thorough understanding</span>
+<span id="L89" class="LineNr"> 89 </span><span class="Comment">//: of each aspect either. The goal of layers is to reward curiosity.</span>
 <span id="L90" class="LineNr"> 90 </span>
 <span id="L91" class="LineNr"> 91 </span><span class="Comment">// Includes</span>
 <span id="L92" class="LineNr"> 92 </span><span class="Comment">// End Includes</span>
@@ -153,19 +153,19 @@ if ('onhashchange' in window) {
 <span id="L94" class="LineNr"> 94 </span><span class="Comment">// Types</span>
 <span id="L95" class="LineNr"> 95 </span><span class="Comment">// End Types</span>
 <span id="L96" class="LineNr"> 96 </span>
-<span id="L97" class="LineNr"> 97 </span><span class="Comment">// Prototypes are auto-generated in the 'build' script; define your functions</span>
-<span id="L98" class="LineNr"> 98 </span><span class="Comment">// in any order. Just be sure to declare each function header all on one line.</span>
-<span id="L99" class="LineNr"> 99 </span><span class="Comment">// Our auto-generation scripts are too minimal and simple-minded to handle</span>
-<span id="L100" class="LineNr">100 </span><span class="Comment">// anything else.</span>
+<span id="L97" class="LineNr"> 97 </span><span class="Comment">// Function prototypes are auto-generated in the 'build' script; define your</span>
+<span id="L98" class="LineNr"> 98 </span><span class="Comment">// functions in any order. Just be sure to declare each function header all on</span>
+<span id="L99" class="LineNr"> 99 </span><span class="Comment">// one line, ending with the '{'. Our auto-generation scripts are too minimal</span>
+<span id="L100" class="LineNr">100 </span><span class="Comment">// and simple-minded to handle anything else.</span>
 <span id="L101" class="LineNr">101 </span><span class="PreProc">#include </span><span class="Constant">&quot;function_list&quot;</span>  <span class="Comment">// by convention, files ending with '_list' are auto-generated</span>
 <span id="L102" class="LineNr">102 </span>
 <span id="L103" class="LineNr">103 </span><span class="Comment">// Globals</span>
 <span id="L104" class="LineNr">104 </span><span class="Comment">//</span>
 <span id="L105" class="LineNr">105 </span><span class="Comment">// All statements in this section should always define a single variable on a</span>
 <span id="L106" class="LineNr">106 </span><span class="Comment">// single line. The 'build' script will simple-mindedly auto-generate extern</span>
-<span id="L107" class="LineNr">107 </span><span class="Comment">// declarations for them. Don't forget to define (not just declare) constants</span>
-<span id="L108" class="LineNr">108 </span><span class="Comment">// with extern linkage in this section, since C++ global constants have</span>
-<span id="L109" class="LineNr">109 </span><span class="Comment">// internal linkage by default.</span>
+<span id="L107" class="LineNr">107 </span><span class="Comment">// declarations for them. Remember to define (not just declare) constants with</span>
+<span id="L108" class="LineNr">108 </span><span class="Comment">// extern linkage in this section, since C++ global constants have internal</span>
+<span id="L109" class="LineNr">109 </span><span class="Comment">// linkage by default.</span>
 <span id="L110" class="LineNr">110 </span><span class="Comment">//</span>
 <span id="L111" class="LineNr">111 </span><span class="Comment">// End Globals</span>
 <span id="L112" class="LineNr">112 </span>
@@ -183,7 +183,7 @@ if ('onhashchange' in window) {
 <span id="L124" class="LineNr">124 </span><span class="Comment">// Unit Tests</span>
 <span id="L125" class="LineNr">125 </span><span class="Comment">// End Unit Tests</span>
 <span id="L126" class="LineNr">126 </span>
-<span id="L127" class="LineNr">127 </span><span class="Comment">//: our first directive; will move the include above the program</span>
+<span id="L127" class="LineNr">127 </span><span class="Comment">//: our first directive; insert the following header at the start of the program</span>
 <span id="L128" class="LineNr">128 </span><span class="Delimiter">:(before &quot;End Includes&quot;)</span>
 <span id="L129" class="LineNr">129 </span><span class="PreProc">#include </span><span class="Constant">&lt;stdlib.h&gt;</span>
 <span id="L130" class="LineNr">130 </span>