Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 35290

Summary:	[doc] Property naming in the builder and the packager
Product:	[Eclipse Project] PDE	Reporter:	Pascal Rapicault <pascal>
Component:	Build	Assignee:	pde-build-inbox <pde-build-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P2	CC:	gunnar
Version:	2.1
Target Milestone:	3.0 RC4
Hardware:	PC
OS:	Windows 2000
Whiteboard:

Description Pascal Rapicault

2003-03-19 10:17:40 EST

Here is the list of the properties used in the builder and the packager with a 
brief description.

(xxx) are old name or properties, the new name is given after. 

Packager
========

workingDirectory: The directory where all the packaging related files will be 
generated, unzipped, ...
downloadDirectory: The directory where the files will be downloaded
tempDirectory: The directory in which the files will be unzipped, and zipped 
from
resultDirectory: The directory where all the results of the packager will be 
stored (used now)

packagingInfo: The directory in which the file called packager.properties is 
located
packagingProperties: A relative path to the file containing the properties for 
element to package

contentFilter: a comma separated list of value used to filter the files that 
are downloaded
config: The config for which the packager is running (it is only one config)
featureList: A comma separated list of features to package

featurePaths: A comma separated list of paths where features and plugins are 
located. An entry must point to one level up above the "features" and "plugins" 
directory (example eclipse)

(collBase) zipBase: The directory from which the zip will be built
(collPlace) rootZipDirectory: The directory that will be used as a root in the 
zip. All the files to be zipped must be under this directory.
A typical configuration of those variables is:
  zipBase=.
  rootZipDirectory=eclipse

zipArgs: Extra arguments that can be passed to the zip command
unzipArgs: Extra arguments that can be passed to the unzip command




Builder
=======
mapVersionTag: Version of the map files used
buildDirectory: The directory in which the build will happen

(collBase) zipBase: The directory from which the zip will be built
(collPlace) rootZipDirectory: The directory that will be used as a root in the 
zip. All the files to be zipped must be under this directory.

configs: an ampersand separated list of config (each component of a config is 
separated by a comma)

bootClasspath: The path to a rt.jar
javacFailOnError: The value that will be used as a parameter to the failonerror 
property of the javac ant task
javacDebugInfo: The value that will be used as a parameter to the debuginfo 
property of the javac ant task
javacVerbose: The value that will be used as a parameter to the verbose 
property of the javac ant task


zipArgs: Extra arguments that can be passed to the zip command
unzipArgs: Extra arguments that can be passed to the unzip command

baseLocation: An installation of eclipse to compile against
baseOs: The Os of the eclipse installed in baseLocation
baseWs: The ws of the eclipse installed in baseLocation
baseArch: The arch of the eclipse installed in baseLocation


Eclipse specific vars
---------------------
buildLabel:
buildId:	also these vars are now used to in some scripts, they should be 
replaced by more generic names
buildType:

timestamp
noMail

Comment 1 Pascal Rapicault

2003-03-20 10:01:23 EST

When doing the replacement/renaming check the case of:
  baseLocation
  javacFailOnError
  baseOS
  baseWS
  baseArch
  bootClasspath

  buildId
  buildLabel
  buildType

Check the scripts for buildid, buildID, buildId

Comment 2 Pascal Rapicault

2003-03-28 11:25:11 EST

Addition of two new javac properties:
  javacSource
  javacTarget

Comment 3 DJ Houghton

2003-11-20 13:15:48 EST

Changing bug assignment to pde-build-inbox. (pde-core-inbox is obsolete)

Comment 4 Pascal Rapicault

2004-04-13 13:12:19 EDT

collBase and collPlace have been removed and replaced with archivePrefix and
collectingFolder.
The semantics of collBase and collPlace changed.

Comment 5 Pascal Rapicault

2004-06-16 21:48:20 EDT

*** Bug 42474 has been marked as a duplicate of this bug. ***

Comment 6 Pascal Rapicault

2004-06-16 21:50:27 EDT

*** Bug 32242 has been marked as a duplicate of this bug. ***

Comment 7 Pascal Rapicault

2004-06-22 18:00:55 EDT

This has been fixed in HEAD.
The doc regarding the usage of the pde build in an automated build mode and the
packager have not been included because they are subject to change and we
already have a stub of an article available.

Comment 8 Gunnar Wagenknecht

2004-07-15 04:05:08 EDT

Is the article stub available in cvs?

Comment 9 Pascal Rapicault

2004-07-15 10:01:38 EDT

There is a description of the pde builder in the org.eclipse.releng.basebuilder 
(file called readme I believe).
Sonia an I are reworking the text, examples of this document in the pde-build-
home project.

No description is available for the packager.