X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?p=pintos-anon;a=blobdiff_plain;f=doc%2Fdevel.texi;h=eae54d163956de002a61f1d78424326704c31509;hp=6496b4fc0973c51a2ca7580c9ebda0e0ce41d3f8;hb=5af653aea4f817d41de3d2ab3a9eeaec44016234;hpb=615bf3b3d2a8573ed6fb9ddc0055745e163ac999

diff --git a/doc/devel.texi b/doc/devel.texi
index 6496b4f..eae54d1 100644
--- a/doc/devel.texi
+++ b/doc/devel.texi
@@ -1,13 +1,21 @@
-@node Development Tools, , Debugging Tools, Top
+@node Development Tools
 @appendix Development Tools
 
 Here are some tools that you might find useful while developing code.
 
 @menu
-* Tags::                        
-* CVS::                         
-* SourceForge::                 
-* VNC::                         
+* Tags::
+* cscope::
+* CVS::
+@ifset recommendsourceforge 
+* SourceForge::
+@end ifset 
+@ifset recommendvnc
+* VNC::
+@end ifset 
+@ifset recommendcygwin
+* Cygwin::
+@end ifset
 @end menu
 
 @node Tags
@@ -26,6 +34,33 @@ the default target.  If a tag name has multiple definitions, @kbd{M-0
 M-.} jumps to the next one.  To jump back to where you were before
 you followed the last tag, use @kbd{M-*}.
 
+@node cscope
+@section cscope
+
+The @command{cscope} program also provides an index to functions and
+variables declared in a program.  It has some features that tag
+facilities lack.  Most notably, it can find all the points in a
+program at which a given function is called.
+
+The @file{Makefile} in @file{pintos/src} produces @command{cscope}
+indexes when it is invoked as @code{make cscope}.  Once the index has
+been generated, run @command{cscope} from a shell command line; no
+command-line arguments are normally necessary.  Then use the arrow
+keys to choose one of the search criteria listed near the bottom of
+the terminal, type in an identifier, and hit @key{Enter}.
+@command{cscope} will then display the matches in the upper part of
+the terminal.  You may use the arrow keys to choose a particular
+match; if you then hit @key{Enter}, @command{cscope} will invoke the
+default system editor@footnote{This is typically @command{vi}.  To
+exit @command{vi}, type @kbd{: q @key{Enter}}.} and position the
+cursor on that match.  To start a new search, type @key{Tab}.  To exit
+@command{cscope}, type @kbd{Ctrl-d}.
+
+Emacs and some versions of @command{vi} have their own interfaces to
+@command{cscope}.  For information on how to use these interface,
+visit @url{http://cscope.sourceforge.net, the @command{cscope} home
+page}.
+
 @node CVS
 @section CVS
 
@@ -39,13 +74,15 @@ as of some given day and time.  The version control logs tell you who
 made changes and when.
 
 CVS is not the best version control system out there, but it's
-free, it's fairly easy to use, and
-it's already available on the Leland machines you're using for
-the projects.
+free, it's fairly easy to use, and it's already installed in most
+Unix-like environments.
 
 For more information, visit the @uref{https://www.cvshome.org/, , CVS
 home page}.
 
+@include localcvsinstructions.texi
+
+@ifset recommendsourceforge
 @node SourceForge
 @section SourceForge
 
@@ -56,7 +93,9 @@ You can use it to store files, track bugs, and post notes about
 development progress.  You can set up your own
 project in SourceForge at @uref{http://sourceforge.net, ,
 sourceforge.net}.
+@end ifset
 
+@ifset recommendvnc
 @node VNC
 @section VNC
 
@@ -64,6 +103,22 @@ VNC stands for Virtual Network Computing.  It is, in essence, a remote
 display system which allows you to view a computing ``desktop''
 environment not only on the machine where it is running, but from
 anywhere on the Internet and from a wide variety of machine
-architectures.  It is already installed on the Leland machines.  For
-more information, look at the @uref{http://www.realvnc.com/, , VNC
+architectures.  It is already installed on the lab machines.  
+For more information, look at the @uref{http://www.realvnc.com/, , VNC
 Home Page}.
+@end ifset
+
+@ifset recommendcygwin
+@node Cygwin
+@section Cygwin
+
+@uref{http://cygwin.com/, ,Cygwin} provides a Linux-compatible environment
+for Windows.  It includes ssh client and an X11 server, Cygwin/X.  If your
+primary work environment is Windows, you will find Cygwin/X extremely
+useful for these projects.  Install Cygwin/X, then start the X server
+and open a new xterm.  The X11 server also allows you to run pintos while
+displaying the bochs- or qemu-emulated console on your Windows desktop.
+@end ifset
+
+@localdevelopmenttools{}
+