Loading...
Helix SwarmHelix Swarm
Loading...

JamUseI.html

  • //
  • guest/
  • neal_firth/
  • JamUseI.html #2
  • View
  • Commits
  • Open Download .zip Download (10 KB) 
  1. <html xmlns:o="urn:schemas-microsoft-com:office:office"
  2. xmlns:w="urn:schemas-microsoft-com:office:word"
  3. xmlns="http://www.w3.org/TR/REC-html40">
  4.  
  5. <head>
  6. <meta http-equiv=Content-Type content="text/html; charset=windows-1252">
  7. <meta name=ProgId content=Word.Document>
  8. <meta name=Generator content="Microsoft Word 9">
  9. <meta name=Originator content="Microsoft Word 9">
  10. <link rel=File-List href="./JamUseI_files/filelist.xml">
  11. <title>Using Jam in a dynamic automated build enviroment</title>
  12. <!--[if gte mso 9]><xml>
  13.  <o:DocumentProperties>
  14.   <o:Author>Neal R. Firth</o:Author>
  15.   <o:Template>Normal</o:Template>
  16.   <o:LastAuthor>Neal R. Firth</o:LastAuthor>
  17.   <o:Revision>3</o:Revision>
  18.   <o:TotalTime>398</o:TotalTime>
  19.   <o:Created>2002-12-17T01:17:00Z</o:Created>
  20.   <o:LastSaved>2002-12-17T01:23:00Z</o:LastSaved>
  21.   <o:Pages>2</o:Pages>
  22.   <o:Words>708</o:Words>
  23.   <o:Characters>4037</o:Characters>
  24.   <o:Company>The Infrastructure Group, Inc.</o:Company>
  25.   <o:Lines>33</o:Lines>
  26.   <o:Paragraphs>8</o:Paragraphs>
  27.   <o:CharactersWithSpaces>4957</o:CharactersWithSpaces>
  28.   <o:Version>9.3821</o:Version>
  29.  </o:DocumentProperties>
  30. </xml><![endif]-->
  31. <style>
  32. <!--
  33.  /* Style Definitions */
  34. p.MsoNormal, li.MsoNormal, div.MsoNormal
  35. 	{mso-style-parent:"";
  36. 	margin:0in;
  37. 	margin-bottom:.0001pt;
  38. 	mso-pagination:widow-orphan;
  39. 	font-size:12.0pt;
  40. 	font-family:"Times New Roman";
  41. 	mso-fareast-font-family:"Times New Roman";}
  42. p.Script, li.Script, div.Script
  43. 	{mso-style-name:Script;
  44. 	margin-top:0in;
  45. 	margin-right:0in;
  46. 	margin-bottom:0in;
  47. 	margin-left:.3in;
  48. 	margin-bottom:.0001pt;
  49. 	mso-pagination:widow-orphan;
  50. 	font-size:12.0pt;
  51. 	font-family:courier,monospace;
  52. 	mso-fareast-font-family:"Times New Roman";
  53. 	mso-bidi-font-family:"Times New Roman";}
  54. @page Section1
  55. 	{size:8.5in 11.0in;
  56. 	margin:1.0in 1.25in 1.0in 1.25in;
  57. 	mso-header-margin:.5in;
  58. 	mso-footer-margin:.5in;
  59. 	mso-paper-source:0;}
  60. div.Section1
  61. 	{page:Section1;}
  62. -->
  63. </style>
  64. </head>
  65.  
  66. <body lang=EN-US style='tab-interval:.5in'>
  67.  
  68. <div class=Section1>
  69.  
  70. <p class=MsoNormal>This example demonstrates the power of Jam
  71. as an integral component of an automated build environment with dynamic
  72. generation requirements.</p>
  73.  
  74. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  75.  
  76. <p class=MsoNormal>A user had a build process that used a manual pre-operation configuration
  77. and typically ran for most of a day because their default dependency rule was
  78. build it just in case we missed it during configuration. Moreover, because of
  79. differences in generation environments, the development build process was
  80. different from the release engineering build process, which was in turn
  81. different from the build process used by support. The primary initial project
  82. goal was to automate the entire build process. A secondary goal was to make the
  83. build process common for all users. Combining Jam with some glue scripts
  84. achieved both of these goals, and more, in a relatively short period of time.</p>
  85.  
  86. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  87.  
  88. <p class=MsoNormal>The primary glue script scans the current working
  89. directory and all of its subdirectories looking for either custom control or Jam
  90. files. Custom control and Jam files are uniquely identifiable through naming
  91. conventions. Custom control files are dynamically resolved into Jam files. Jam
  92. files are referenced directly. All of these Jam files are then referenced by a
  93. common include file that forms the input control for a Jam based build master.</p>
  94.  
  95. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  96.  
  97. <p class=MsoNormal>The general form of the Jam based build master is:</p>
  98.  
  99. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  100.  
  101. <p class=Script># Expected argument sequence:</p>
  102.  
  103. <p class=Script>#<span style="mso-spacerun: yes"> </span>$1 - File to be
  104. generated</p>
  105.  
  106. <p class=Script>#<span style="mso-spacerun: yes"> </span>$2 - Primary source
  107. for file being generated</p>
  108.  
  109. <p class=Script>#<span style="mso-spacerun: yes"> </span>$3 - Configuration
  110. control files for source</p>
  111.  
  112. <p class=Script>#<span style="mso-spacerun: yes"> </span>$4 - Generation
  113. program (with options)</p>
  114.  
  115. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  116.  
  117. <p class=Script>rule Generate {</p>
  118.  
  119. <p class=Script><span style='mso-tab-count:1'> </span>GENERATOR on $(1) =
  120. $(4) ;</p>
  121.  
  122. <p class=Script><span style='mso-tab-count:1'> </span>CONTROLS on $(1) =
  123. &quot;-c &quot;$(3) ;</p>
  124.  
  125. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  126.  
  127. <p class=Script><span style='mso-tab-count:1'> </span>Depends all : $(1) ;</p>
  128.  
  129. <p class=Script><span style='mso-tab-count:1'> </span>Depends $(1) : $(2)
  130. $(3) $(4) ;</p>
  131.  
  132. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  133.  
  134. <p class=Script><span style='mso-tab-count:1'> </span>Generator $(1) : $(2)
  135. ;</p>
  136.  
  137. <p class=Script>}</p>
  138.  
  139. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  140.  
  141. <p class=Script>actions ignore Generator {</p>
  142.  
  143. <p class=Script><span style='mso-tab-count:1'> </span>$(GENERATOR) $(CONTROLS)
  144. -o $(1) $(2)</p>
  145.  
  146. <p class=Script>}</p>
  147.  
  148. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  149.  
  150. <p class=Script># What has the script found this time??</p>
  151.  
  152. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  153.  
  154. <p class=Script>{</p>
  155.  
  156. <p class=Script><span style='mso-tab-count:1'> </span>include ThisRun ;</p>
  157.  
  158. <p class=Script>}</p>
  159.  
  160. <p class=Script><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  161.  
  162. <p class=MsoNormal>The contents of ThisRun would reference Jam files that
  163. ultimately specified instructions such as this:</p>
  164.  
  165. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  166.  
  167. <p class=Script>Generate O : Y : c1 c2 : bin\\gen ;</p>
  168.  
  169. <p class=Script>Generate c1 : Z : c2 : bin\\cgen ;</p>
  170.  
  171. <p class=Script>Generate c2 : Z : : bin\\cgen ;</p>
  172.  
  173. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  174.  
  175. <p class=MsoNormal>Using this straightforward structure, all users can use the
  176. same build process because the process adapts to the users environment. A user
  177. only needs to populate their environment with the files being worked on.
  178. Instead of a manual, and often error prone, specification process the tools
  179. dynamically adapt to the users environment. Missing environmental dependencies
  180. are quickly identified as part of the Jam output. For example, if the cgen generator
  181. was missing from your environment in the example above, youd see something
  182. like this as output from Jam and youd know you were missing the generator
  183. program:</p>
  184.  
  185. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  186.  
  187. <p class=Script>don't know how to make bin\cgen</p>
  188.  
  189. <p class=Script>found 8 target(s)...</p>
  190.  
  191. <p class=Script>can't find 1 target(s)...</p>
  192.  
  193. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  194.  
  195. <p class=MsoNormal>And there were other benefits to using Jam in this process.
  196. Prior to this process, build times were not particularly predictable. Some
  197. types of generators typically ran for seconds, others for minutes, and others
  198. for tens of minutes. Evaluating build times or the impact of what if
  199. scenarios required significant effort. Jams o option presented a solution to
  200. this problem. For the example above, running Jam with the o option would
  201. generate output that looked like this:</p>
  202.  
  203. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  204.  
  205. <p class=Script>bin\cgen<span style="mso-spacerun: yes"> </span>-o c2<span
  206. style="mso-spacerun: yes"> </span>Z </p>
  207.  
  208. <p class=Script>bin\cgen<span style="mso-spacerun: yes"> </span>-c c2<span
  209. style="mso-spacerun: yes"> </span>-o c1<span style="mso-spacerun: yes">
  210. </span>Z </p>
  211.  
  212. <p class=Script>bin\gen<span style="mso-spacerun: yes"> </span>-c c1 -c
  213. c2<span style="mso-spacerun: yes"> </span>-o O<span style="mso-spacerun:
  214. yes"> </span>Y</p>
  215.  
  216. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  217.  
  218. <p class=MsoNormal>The results are scanned for the presence of specific
  219. generators. Each instance of a specific generator is associated with a
  220. processing time estimate and thus build times can be predicted. Even for
  221. complex environments involving thousands of generated objects the processing
  222. time for the glue scanner, Jam, and the o evaluator was typically minutes.</p>
  223.  
  224. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  225.  
  226. <p class=MsoNormal>Output from Jams o option was also used as input to a
  227. pre-generation validation of build results. This was very important in an
  228. environment where release build cycles were typically measured in significant
  229. fractions of a day. The output from running Jam with o could be scanned for
  230. important build elements. If an expected element build was not going to happen,
  231. you knew in minutes rather than in hours. This simple technique had a dramatic
  232. impact on release engineering productivity and the usability of releases.</p>
  233.  
  234. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  235.  
  236. <p class=MsoNormal>This process has adapted and evolved over time to include
  237. new elements of the environment. Initially, the process encompassed the users
  238. custom generation needs. Eventually, the glue scanner was enhanced to scan
  239. Microsoft Visual Studio VBP and DSP files for dependencies that were used as
  240. input to a generator compilation rule.</p>
  241.  
  242. <p class=MsoNormal><![if !supportEmptyParas]>&nbsp;<![endif]><o:p></o:p></p>
  243.  
  244. <p class=MsoNormal>Jams inherent separation of platform-dependent issues was
  245. also a benefit. Initially, this process was developed and debugged in a Windows
  246. environment. Having used Jam as the build manager made adapting these processes
  247. to MAC and UNIX systems a straightforward task. The generated Jam scripts transported
  248. as is. The most complex part of the porting task was adapting the glue
  249. scanners.</p>
  250.  
  251. </div>
  252.  
  253. </body>
  254.  
  255. </html>
# Change User Description Committed
#2 2588 Neal Firth Update for Jam example. 22 years ago
#1 2510 Neal Firth Revised for internal information consistency and use of fixed space fonts
in the code/out...put text. «		 22 years ago