Changeset 1554 in ProjectBuilder for devel/pb/bin

Timestamp:

May 21, 2012, 3:19:04 AM (13 years ago)

Author:

Bruno Cornec

Message:

• pb: Update documentation, the newproj docs were missing an important argument. Expanded out the newproj documentation. Fixed the cms2build documentation to match the same style as the other documentation. (Eric Anderson)
• CMS.pm/VCS.pm: Tolerate the file: scheme -- it was tolerated in some places but not others. (Eric Anderson)

File:

• devel/pb/bin/pb (modified) (1 diff)

devel/pb/bin/pb

@@ -479 +479 @@
 You can then run the command:
 
- % pb -p I<$project> -r I<$version> newproj
-
-to create the new project. Running the newproj command will then generate the file $pbdefdir/$project/pbconf/$version/$project.pb.  You will need to edit that file in order to run any of the later commands.
+ % pb -p I<$project> -r I<$version> newproj I<$pkg>
+
+to create the new project. Running the newproj command will then generate the file $pbdefdir/$project/pbconf/$version/$project.pb, and the directory $pbdefdir/$project/pbconf/$version/$pkg. You will need to edit those files to make the later commands work.
 
 =head2 cms2build
 
-The cms2build command takes your files from the content management system and makes the two tar files that are necessary for building files. Before running this command, you need to run the newproj command, and edit the $project.pb configuration file. In particular, you need to set the pburl, pbrepo, pbwf, pbpackager, projver, projtag, testver, deliver, and defpkgdir lines as described in the configuration file. Then you can run a command like:
+The cms2build command takes your files from the content management system and makes the two tar files that are necessary for building files. You need to have run the newproj command first.  Then there are several steps for running this command:
+
+=over 4
+
+=item Update your $project.pb configuration file.
+
+You need to set the pburl, pbrepo, pbwf, pbpackager, projver, projtag, testver, delivery, and defpkgdir lines as described in the configuration file.  For example:
+
+ pburl Lintel = file:///home/anderse/projects/Lintel-0.2012.02.28.tar.gz
+ pbrepo Lintel = http://tesla.hpl.hp.com/opensource
+ pbwf Lintel = 1
+ pbpackager Lintel = Eric Anderson <eric.anderson4@hp.com>
+ projver Lintel = 0.2012.02.28
+ projtag Lintel = 1
+ testver Lintel = false
+ delivery Lintel = production
+ defpkgdir Lintel = Lintel-0.2012.02.28
+
+=item Create the build .tar.gz files:
+
+Then you need to take those files and create the initial tar files.  Run a command like:
 
  % pb -p $project -r $version cms2build
 
 To create the $pbdefdir/$project/delivery/$project-$version.{,pbconf}.tar.gz files, the $version-$projtag.pb and pbrc files in the same directory.
+
+=back
 
 =head2 build2pkg