Helix SwarmHelix Swarm
Loading...

README.html

  • //
  • guest/
  • chris_comparini/
  • jam_sample/
  • sample/
  • abstract/
  • README.html #1
  • View
  • Commits
  • Open Download .zip Download (3 KB) 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Final//EN">
  2. <HTML>
  3.  <HEAD>
  4.   <TITLE>Abstract multi-directory Jam example</TITLE>
  5.  </HEAD>
  6.  
  7.  <BODY>
  8.  
  9.  <p>This is a somewhat abstract example of one way in which you can use
  10.     Jam to build a project whose sources are spread over several
  11.     subdirectories.
  12.  
  13.  <p>In this example, we introduce the "Jamrules" file, which generally contains
  14.     site or project specific configuration, rules, and actions.  In this
  15.     case, the Jamrules only sets the ALL_LOCATE_TARGET variable, which
  16.     specifies where to put generated files.
  17.  
  18.  <p>We also demonstrate the use of the SubDir and SubInclude rules to 
  19.     compile the contents of sub directories.
  20.  
  21.  <p>Note that there's a Jamfile for each directory in which sources reside.
  22.     Each contains only a call to the Library rule specifying that a library
  23.     should be made from the source files in that directory.  The Jamfiles 
  24.     in the sub directories could of course be arbitrarily complex, but it
  25.     is usually best to keep them as simple as possible.
  26.  
  27.  <p>Things to try:
  28.    <ul>
  29.      <li>Run jam, then touch or edit one of the header files - for example,
  30.          "b.h" in the "b" directory.  Notice that jam knew which source files
  31.          #included "b.h" (see the section called "Header File Processing" in the
  32.          <a href="http://public.perforce.com/public/jam/src/Jamfile.html">
  33.           Jamfiles and Jambase</a> document for information on how this works).
  34.          Then try making one header file #include another, and touch the
  35.          #included file.  Jam understands the new relationship, without
  36.          the need for a "make depends", and it does it fast.
  37.      <li>Do a "jam clean" from the top directory, and then try running jam
  38.          from within one of the source sub directories.  Note that (with this
  39.          particular setup) Jam will only compile the library corresponding
  40.          to that particular sub directory.  This sort of arrangement can be
  41.          helpful in modularizing large and/or multi-platform projects.
  42.      <li>Try adding your own call to "InstallBin" in the top level Jamfile
  43.          (see the <a href="../simple">simple</a> example for an example
  44.          of using InstallBin).  Then, hypothesize that for this project
  45.          you actually want to install one or more of the libraries, and 
  46.          add a call to "InstallLib" to tell jam which libraries to install
  47.          and where.  (Hint:  on a "real" project, the directory into which
  48.          things are installed would probably be specified one way or another
  49.          in the Jamrules.  Try setting a variable containing your install
  50.          path in the Jamrules and then pass that variable to the appropriate
  51.          install rule.)
  52.          See the 
  53.          <a href="http://public.perforce.com/public/jam/src/Jamfile.html">
  54.          Jamfiles and Jambase</a> file for more information on InstallLib and
  55.          other rules.
  56.    </ul>
  57.  
  58.  </BODY>
  59. </HTML>
# Change User Description Committed
#1 4438 Chris Comparini Sample jam projects.
 "rootless" documentation still needs work. 		21 years ago