pintos-os.org Git - pintos-anon/blob - doc/localsettings.texi

   1 @c Local settings
   2
   3 @set gitrepo file:///usr/class/cs140/winter13/pintos/.git
   4 @set localpintoshttppath http://@/www.stanford.edu/@/class/@/cs140/@/pintos/@/pintos.@/tar.gz
   5 @set localpintosbindir /usr/class/cs140/`uname -m`/bin
   6
   7 @set recommendvnc
   8 @set recommendgit
   9 @clear recommendcygwin
  10 @clear recommendcvs
  11
  12 @macro localmachines{}
  13 The CS 140 ``officially supported'' Pintos development machines are
  14 those in the myth, corn, and cardinal clusters.
  15 @end macro
  16
  17 @macro localpathsetup{}
  18 Under @command{csh}, Stanford's login shell, you can do so
  19 with this command:@footnote{The term @samp{`uname -m`} expands to a value
  20 such as @file{x86_64} that indicates the type of computer you're
  21 logged into.}
  22 @example
  23 set path = ( @value{localpintosbindir} $path )
  24 @end example
  25 @noindent
  26 @strong{Notice that both @samp{`} are left single quotes or
  27 ``backticks,'' not apostrophes (@samp{'}).}
  28 It is a good idea to add this line to the @file{.cshrc} file
  29 in your home directory.  Otherwise, you'll have to type it every time
  30 you log in.
  31 @end macro
  32
  33 @macro localcrossbuild{}
  34 @end macro
  35
  36 @macro localhonorcodepolicy{}
  37 In the context of Stanford's CS 140 course, please respect the spirit
  38 and the letter of the honor code by refraining from reading any homework
  39 solutions available online or elsewhere.  Reading the source code for
  40 other operating system kernels, such as Linux or FreeBSD, is allowed,
  41 but do not copy code from them literally.  Please cite the code that
  42 inspired your own in your design documentation.
  43 @end macro
  44
  45 @macro localcredits{}
  46 @c none needed
  47 @end macro
  48
  49 @macro localcvspolicy{}
  50 Instead, we recommend integrating your team's changes early and often,
  51 using a source code control system such as Git (@pxref{Git}).
  52 This is less likely to produce surprises, because everyone can see
  53 everyone else's code as it is written, instead of just when it is
  54 finished.  These systems also make it possible to review changes and,
  55 when a change introduces a bug, drop back to working versions of code.
  56 @end macro
  57
  58 @macro localcodingstandards{}
  59 @c If appropriate, describe additional local coding standards here.
  60 @end macro
  61
  62 @macro localdevelopmenttools{}
  63 @c Descriptions of additional, local development tools can be inserted here
  64 @end macro