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

   1 @c Local settings
   2
   3 @set coursenumber CS 140
   4 @set localpintostarpath /usr/class/cs140/pintos/pintos.tar.gz
   5 @set localpintoshttppath http://@/www.stanford.edu/@/class/@/cs140/@/pintos/@/pintos.@/tar.gz
   6 @set localpintosbindir /usr/class/cs140/`uname -m`/bin
   7
   8 @set recommendsourceforge
   9 @set recommendvnc
  10 @clear recommendcygwin
  11
  12 @macro localmachines{}
  13 The CS 140 ``officially supported'' Pintos development machines are
  14 the machines in Sweet Hall managed by Stanford ITSS, as described on
  15 the @uref{http://www.stanford.edu/services/cluster/environs/sweet/, ,
  16 ITSS webpage}.  You may use the Solaris or Linux machines.
  17 @end macro
  18
  19 @macro localpathsetup{}
  20 Under @command{csh}, Stanford's login shell, you can do so
  21 with this command:@footnote{The term @samp{`uname -m`} expands to either
  22 @file{sun4u} or @file{i686} according to the type of computer you're
  23 logged into.}
  24 @example
  25 set path = ( @value{localpintosbindir} $path )
  26 @end example
  27 @noindent
  28 @strong{Notice that both @samp{`} are left single quotes or
  29 ``backticks,'' not apostrophes (@samp{'}).}
  30 It is a good idea to add this line to the @file{.cshrc} file
  31 in your home directory.  Otherwise, you'll have to type it every time
  32 you log in.
  33 @end macro
  34
  35 @macro localcrossbuild{}
  36 Watch the commands executed during the build.  On the Linux machines,
  37 the ordinary system tools are used.  On a SPARC machine, special build
  38 tools are used, whose names begin with @samp{i386-elf-}, e.g.@:
  39 @code{i386-elf-gcc}, @code{i386-elf-ld}.  These are ``cross-compiler''
  40 tools.  That is, the build is running on a SPARC machine (called the
  41 @dfn{host}), but the result will run on a simulated 80@var{x}86 machine
  42 (called the @dfn{target}).  The @samp{i386-elf-@var{program}} tools are
  43 specially built for this configuration.
  44 @end macro
  45
  46 @macro localhonorcodepolicy{}
  47 In the context of Stanford's CS 140 course, please respect the spirit
  48 and the letter of the honor code by refraining from reading any homework
  49 solutions available online or elsewhere.  Reading the source code for
  50 other operating system kernels, such as Linux or FreeBSD, is allowed,
  51 but do not copy code from them literally.  Please cite the code that
  52 inspired your own in your design documentation.
  53 @end macro
  54
  55 @macro localcredits{}
  56 @c none needed
  57 @end macro
  58
  59 @macro localcvspolicy{}
  60 Instead, we recommend integrating your team's changes early and often,
  61 using a source code control system such as CVS (@pxref{CVS}) or a
  62 group collaboration site such as SourceForge (@pxref{SourceForge}).
  63 This is less likely to produce surprises, because everyone can see
  64 everyone else's code as it is written, instead of just when it is
  65 finished.  These systems also make it possible to review changes and,
  66 when a change introduces a bug, drop back to working versions of code.
  67 @end macro
  68
  69 @macro localcodingstandards{}
  70 All of you should have taken a class like CS 107, so we expect you to be
  71 familiar with some set of coding standards such as
  72 @uref{http://www.stanford.edu/class/cs140/projects/misc/CodingStandards.pdf,
  73 , CS 107 Coding Standards}. Even if you've taken 107, we recommend
  74 reviewing that document.  We expect code at the ``Peer-Review Quality''
  75 level described there.
  76 @end macro
  77
  78 @macro localdevelopmenttools{}
  79 @c Descriptions of additional, local development tools can be inserted here
  80 @end macro