X-Git-Url: http://v3vee.org/palacios/gitweb/gitweb.cgi?p=palacios.git;a=blobdiff_plain;f=manual%2Fmanual.tex;fp=manual%2Fmanual.tex;h=efed24dd55b66928c48143f6774dbb585f57265b;hp=aaa4dc4d2246aca8c3333a2de867366ca3b7d1ba;hb=bf5cbaffc0d7bae69f5f9ee02a6dc28efa52b573;hpb=b65297c305017bb77bdbc6d056702df0565673ad diff --git a/manual/manual.tex b/manual/manual.tex index aaa4dc4..efed24d 100755 --- a/manual/manual.tex +++ b/manual/manual.tex @@ -310,10 +310,20 @@ overlooked principle of design gives the eye a "place to rest," increasing the appeal of a composition through subtle means." \newline\newline Translation: Use the spacebar, newlines, and parentheses. -\newline\newline + +Curly-brackets are not optional, even for single line conditionals. + +Tabs should be 4 characters in width. + +{\em Special:} If you are using XEmacs add the following to your \verb.init\.el. file: +\begin{verbatim} +(setq c-basic-offset 4) +(c-set-offset 'case-label 4) +\end{verbatim} + {\em Bad} \begin{verbatim} -if(a&&b==5||c!=0){return;} +if(a&&b==5||c!=0) return; \end{verbatim} @@ -322,10 +332,12 @@ if(a&&b==5||c!=0){return;} \begin{verbatim} if (((a) && (b == 5)) || (c != 0)) { - return; + return; } \end{verbatim} + + \paragraph*{Fail Stop} Because booting a basic linux kernel results in over 1 million VM exits catching silent errors is next to impossible. For this reason @@ -358,7 +370,7 @@ whenever possible. \item \verb.v3_. prefix \newline Major interface functions should be named with the prefix \verb.v3_. This -allows easy understanding of how to interact with the subsystems. And +xallows easy understanding of how to interact with the subsystems. And in the case that they need to be externally visible to the host os, make them unlikely to collide with other functions. \end{enumerate} @@ -374,8 +386,8 @@ Two functions of note are \verb.PrintDebug. and \verb.PrintError.. \item PrintDebug: \newline -Should be used for debugging output that will often be -turned off selectively by the VMM configuration. +Should be used for debugging output that will often be turned off +selectively by the VMM configuration. \item PrintError \newline @@ -491,7 +503,7 @@ hgext.mq= \end{verbatim} Mercurial queues use the same stack operations as stacked git, however -does not automatically handle the synchronization with pull +it does not automatically handle the synchronization with pull operations. Before you update from the central version of Kitten you need to pop all of the patches, and then push them once the update is complete. @@ -501,7 +513,7 @@ Basically: hg qpop -a hg pull hg update -hg qupush -a +hg qpush -a \end{verbatim}