Changeset 985 in ProjectBuilder
- Timestamp:
- Feb 21, 2010, 6:29:04 PM (15 years ago)
- File:
-
- 1 edited
-
devel/pb-doc/pb.conf.pod (modified) (27 diffs)
Legend:
- Unmodified
- Added
- Removed
-
devel/pb-doc/pb.conf.pod
r962 r985 17 17 The key could be also default, in which case it will be used as a default value if no more precise content is given for the key. 18 18 19 Each value is detailed below giving the nature of its use (Mandatory or Optional - only used for certain feature), the value of the key (could be the project, a distribution name, default, ...), the value of the parameter field and its format, the default configuration file in which it should be defined and an example of use. 20 19 21 =head1 OPTIONS 20 22 … … 23 25 =item B<defpkgdir>> 24 26 27 Nature: Mandatory 25 28 Key: project (as defined in the -p option or PBPROJ environment variable) 26 29 Value: coma separated list of packages built by default in this project. When not using any package name as a parameter to pb commands, this list will be used. … … 31 34 =item B<extpkgdir> 32 35 36 Nature: Optional 33 37 Key: project (as defined in the -p option or PBPROJ environment variable) 34 38 Value: coma separated list of packages built in addition in this project. When using the all package name as a parameter to pb commands, this list will be used, in addition to the defpkgdir list. … … 38 42 =item B<filteredfiles> 39 43 44 Nature: Optional 40 45 Key: package (as provided in defpkgdir or extpkgdir) 41 46 Value: coma separated list of files that will be filtered using the macro system from pb, during the creation of the compressed source tar files for this package. Their path is relative to the directory containing the package. … … 45 50 =item B<namingtype> 46 51 52 Nature: Optional 47 53 Key: package (as provided in defpkgdir or extpkgdir) 48 54 Value: perl, if packages are CPAN perl modules that need to be named respecting the distribution perl convention (perl-Name for rpm, libname-perl for deb) … … 52 58 =item B<osambiguous> 53 59 60 Nature: Optional 54 61 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an OS name. 55 62 Value: coma separated list of distributions which use the same file name in /etc for different distributions (ex: /etc/redhat-release for redhat, rhel, mandriva,...). Cf: B<osrelambfile> … … 59 66 =item B<oscodename> 60 67 68 Nature: Optional 61 69 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an os-ver. 62 70 Value: code name. Mostly useful for debian and ubuntu, due to debootstrap. … … 66 74 =item B<osfamily> 67 75 76 Nature: Mandatory 68 77 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). In that case, should be an os. 69 78 Value: OS family name (used to group similar distribution for handling) … … 73 82 =item B<osmindep> 74 83 84 Nature: Optional 75 85 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). NB: a default value is highly interesting here. 76 86 Value: coma separated list of packages needed before setupvm|ve can be run. Install them with your distribution in VM or automatically in VE when possible. … … 80 90 =item B<osnover> 81 91 92 Nature: Optional 82 93 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). 83 94 Value: true|false. True means that this OS has no need to keep the version … … 87 98 =item B<osperldep> 88 99 100 Nature: Optional 89 101 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). 90 102 Value: coma separated list of perl modules needed by pb and not provided in a package format for the relative OS, and that will be installed from CPAN in your VM/VE. … … 94 106 =item B<osperlver> 95 107 108 Nature: Mandatory (for each module mentioned in B<osperldep>) 96 109 Key: Perl Module (as defined in B<osperldep>) 97 110 Value: Version of the perl module that needs to be found on CPAN. … … 101 114 =item B<ospkgdep> 102 115 116 Nature: Optional 103 117 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). 104 118 Value: coma separated list of packages that are needed by pb and should be installed automatically in the VM/VE during the setupvm|ve phasis by pb. … … 108 122 =item B<osrelambfile> 109 123 124 Nature: Mandatory (per OS mentioned in B<osambiguous>) 110 125 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Should be the OS name here. 111 Value: full path name of the ambiguous file describing that distribution, as well as some others. All the distributions mentioned here should also be mentioned with their am iguous other distribution in the B<osambiguous> parameter.126 Value: full path name of the ambiguous file describing that distribution, as well as some others. All the distributions mentioned here should also be mentioned with their ambiguous other distribution in the B<osambiguous> parameter. 112 127 Conffile: pb 113 128 Example: osrelambfile debian = /etc/debian_version … … 115 130 =item B<osrelexpr> 116 131 132 Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>) 117 133 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). 118 134 Value: the perl regular expression used to parse the B<osrelambfile> in order to extract from it the version of the distribution (in parenthesis to allow its usage as $1 by perl) … … 123 139 =item B<osrelfile> 124 140 141 Nature: Mandatory 125 142 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). Should be the OS name here. 126 Value: full path name of the file describing non-ambiguously that distribution. T Here should be q bijection between the file qnd the distribution name.143 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name. 127 144 Conffile: pb 128 145 Example: osrelfile fedora = /etc/fedora-release … … 130 147 =item B<osremovedotinver> 131 148 149 Nature: Optional 132 150 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). 133 151 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS. … … 137 155 =item B<ossuffix> 138 156 157 Nature: Optional 139 158 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). 140 159 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version. … … 144 163 =item B<ostype> 145 164 165 Nature: Mandatory 146 166 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here. 147 167 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type. … … 151 171 =item B<osupd> 152 172 173 Nature: Optional 153 174 Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch). The family name is generaly used here. 154 175 Value: OS command to lauch in order to automatically install packages on it. … … 158 179 =item B<pbconfurl> 159 180 181 Nature: Mandatory 160 182 Key: project (as defined in the -p option or PBPROJ environment variable) 161 183 Value: B<pb URL> giving access to where the pb configuration dir is stored. Under that directory you have the same tree infrastructure as the upstream project, and under the pb packaging infra, including the project configuration file. Cf: man 162 Conffile: home 184 Conffile: home|project 163 185 Example: pbconfurl fossology = svn+ssh://user@svn.project-builder.org/mondo/svn/pb/projects/fossology/pbconf, cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe/pbconf 164 186 165 187 =item B<pbdefdir> 166 188 189 Nature: Optional 167 190 Key: project (as defined in the -p option or PBPROJ environment variable) 168 191 Value: local directory under which every pb related operation will take place. if not defined then /var/cache. A default value is highly interesting here. If you want to use VMs/VEs, then use $ENV{'HOME'} to make it portable to it. … … 172 195 =item B<pbml> 173 196 197 Nature: Optional (Mandatory if using announce command) 174 198 Key: project (as defined in the -p option or PBPROJ environment variable) 175 199 Value: white space separated list of e-mail adresses used to send announces with the pb announce option. … … 179 203 =item B<pbpackager> 180 204 205 Nature: Mandatory 181 206 Key: project (as defined in the -p option or PBPROJ environment variable) 182 207 Value: Firstname Name and e-mail address of the person packaging the software. … … 186 211 =item B<pbprojdir> 187 212 188 Key: project (as defined in the -p option or PBPROJ environment variable) 189 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. 213 Nature: Optional 214 Key: project (as defined in the -p option or PBPROJ environment variable) 215 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname 190 216 Conffile: home 191 217 Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue … … 193 219 =item B<pbrepo> 194 220 221 Nature: Mandatory 195 222 Key: project (as defined in the -p option or PBPROJ environment variable) 196 223 Value: URL of the server hosting the upstream tar file. … … 200 227 =item B<pbsmtp> 201 228 229 Nature: Optional (Mandatory if using the announce command) 202 230 Key: project (as defined in the -p option or PBPROJ environment variable) 203 231 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here. … … 209 237 Nature: Optional 210 238 Key: project (as defined in the -p option or PBPROJ environment variable) 211 Value: name of the command to use to socksify network calls. 239 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here. 212 240 Conffile: home 213 241 Example: pbsockscmd default = tsocks 214 242 215 243 =item B<pburl> 216 =item B<pbver> 244 245 Nature: Optional 246 Key: project (as defined in the -p option or PBPROJ environment variable) 247 Value: B<pb URL> giving access to where the project is stored. Normaly provided by the project, but could be overloaded for specific authentication information in the home configuration file or when using a DVCS 248 Conffile: home|project 249 Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb 250 217 251 =item B<pbwf> 252 253 Nature: Optional 254 Key: project (as defined in the -p option or PBPROJ environment variable) 255 Value: whatever. As soon as this is defined, then that project is known as not well formed (have a subdirectory in its tar file under which all sources are put named project-version). This should be reported upstream to the project. tar files generated by project-builder to not suffer from that. This is valid when packaging for tar files and not CMS. 256 Conffile: project 257 Example: pbwf afio = 1 258 218 259 =item B<pkgtag> 260 261 Nature: Optional 262 Key: package (as provided in defpkgdir or extpkgdir) 263 Value: Tag that needs to be used in package name (on rpm: name-ver-tag.arch.rpm). Useful when republishing a package due to package build modification (not code). 264 Conffile: project 265 Example: pkgtag mindi-busybox = 2 266 219 267 =item B<pkgver> 268 269 Nature: Optional 270 Key: package (as provided in defpkgdir or extpkgdir) 271 Value: Version that needs to be used in package name (on rpm: name-ver-tag.arch.rpm). 272 Conffile: project 273 Example: 274 220 275 =item B<projtag> 221 276 =item B<projver>
Note:
See TracChangeset
for help on using the changeset viewer.
