Changeset 985


Ignore:
Timestamp:
Feb 21, 2010, 6:29:04 PM (10 years ago)
Author:
Bruno Cornec
Message:

r3699@localhost: bruno | 2010-02-20 05:22:28 +0100

  • Improves pb.conf documentation
File:
1 edited

Legend:

Unmodified
Added
Removed
  • devel/pb-doc/pb.conf.pod

    r962 r985  
    1717The 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.
    1818
     19Each 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
    1921=head1 OPTIONS
    2022
     
    2325=item B<defpkgdir>>
    2426
     27Nature: Mandatory
    2528Key: project (as defined in the -p option or PBPROJ environment variable)
    2629Value: 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.
     
    3134=item B<extpkgdir>
    3235
     36Nature: Optional
    3337Key: project (as defined in the -p option or PBPROJ environment variable)
    3438Value: 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.
     
    3842=item B<filteredfiles>
    3943
     44Nature: Optional
    4045Key: package (as provided in defpkgdir or extpkgdir)
    4146Value: 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.
     
    4550=item B<namingtype>
    4651
     52Nature: Optional
    4753Key: package (as provided in defpkgdir or extpkgdir)
    4854Value: 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)
     
    5258=item B<osambiguous>
    5359
     60Nature: Optional
    5461Key: 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.
    5562Value: 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>
     
    5966=item B<oscodename>
    6067
     68Nature: Optional
    6169Key: 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.
    6270Value: code name. Mostly useful for debian and ubuntu, due to debootstrap.
     
    6674=item B<osfamily>
    6775
     76Nature: Mandatory
    6877Key: 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.
    6978Value: OS family name (used to group similar distribution for handling)
     
    7382=item B<osmindep>
    7483
     84Nature: Optional
    7585Key: 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.
    7686Value: 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.
     
    8090=item B<osnover>
    8191
     92Nature: Optional
    8293Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
    8394Value: true|false. True means that this OS has no need to keep the version
     
    8798=item B<osperldep>
    8899
     100Nature: Optional
    89101Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
    90102Value: 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.
     
    94106=item B<osperlver>
    95107
     108Nature: Mandatory (for each module mentioned in B<osperldep>)
    96109Key: Perl Module (as defined in B<osperldep>)
    97110Value: Version of the perl module that needs to be found on CPAN.
     
    101114=item B<ospkgdep>
    102115
     116Nature: Optional
    103117Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
    104118Value: 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.
     
    108122=item B<osrelambfile>
    109123
     124Nature: Mandatory (per OS mentioned in B<osambiguous>)
    110125Key: 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 amiguous other distribution in the B<osambiguous> parameter.
     126Value: 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.
    112127Conffile: pb
    113128Example: osrelambfile debian = /etc/debian_version
     
    115130=item B<osrelexpr>
    116131
     132Nature: Mandatory (per OS mentioned in B<osrelambfile> and B<osrelfile>)
    117133Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
    118134Value: 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)
     
    123139=item B<osrelfile>
    124140
     141Nature: Mandatory
    125142Key: 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. THere should be q bijection between the file qnd the distribution name.
     143Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
    127144Conffile: pb
    128145Example: osrelfile fedora = /etc/fedora-release
     
    130147=item B<osremovedotinver>
    131148
     149Nature: Optional
    132150Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
    133151Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
     
    137155=item B<ossuffix>
    138156
     157Nature: Optional
    139158Key: OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch).
    140159Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
     
    144163=item B<ostype>
    145164
     165Nature: Mandatory
    146166Key: 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.
    147167Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
     
    151171=item B<osupd>
    152172
     173Nature: Optional
    153174Key: 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.
    154175Value: OS command to lauch in order to automatically install packages on it.
     
    158179=item B<pbconfurl>
    159180
     181Nature: Mandatory
    160182Key: project (as defined in the -p option or PBPROJ environment variable)
    161183Value: 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
     184Conffile: home|project
    163185Example: 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
    164186
    165187=item B<pbdefdir>
    166188
     189Nature: Optional
    167190Key: project (as defined in the -p option or PBPROJ environment variable)
    168191Value: 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.
     
    172195=item B<pbml>
    173196
     197Nature: Optional (Mandatory if using announce command)
    174198Key: project (as defined in the -p option or PBPROJ environment variable)
    175199Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
     
    179203=item B<pbpackager>
    180204
     205Nature: Mandatory
    181206Key: project (as defined in the -p option or PBPROJ environment variable)
    182207Value: Firstname Name and e-mail address of the person packaging the software.
     
    186211=item B<pbprojdir>
    187212
    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.
     213Nature: Optional
     214Key: project (as defined in the -p option or PBPROJ environment variable)
     215Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
    190216Conffile: home
    191217Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
     
    193219=item B<pbrepo>
    194220
     221Nature: Mandatory
    195222Key: project (as defined in the -p option or PBPROJ environment variable)
    196223Value: URL of the server hosting the upstream tar file.
     
    200227=item B<pbsmtp>
    201228
     229Nature: Optional (Mandatory if using the announce command)
    202230Key: project (as defined in the -p option or PBPROJ environment variable)
    203231Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
     
    209237Nature: Optional
    210238Key: project (as defined in the -p option or PBPROJ environment variable)
    211 Value: name of the command to use to socksify network calls.
     239Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
    212240Conffile: home
    213241Example: pbsockscmd default = tsocks
    214242
    215243=item B<pburl>
    216 =item B<pbver>
     244
     245Nature: Optional
     246Key: project (as defined in the -p option or PBPROJ environment variable)
     247Value: 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
     248Conffile: home|project
     249Example: pburl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pburl pb = svk:////local/pb
     250
    217251=item B<pbwf>
     252
     253Nature: Optional
     254Key: project (as defined in the -p option or PBPROJ environment variable)
     255Value: 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.
     256Conffile: project
     257Example: pbwf afio = 1
     258
    218259=item B<pkgtag>
     260
     261Nature: Optional
     262Key: package (as provided in defpkgdir or extpkgdir)
     263Value: 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).
     264Conffile: project
     265Example: pkgtag mindi-busybox = 2
     266
    219267=item B<pkgver>
     268
     269Nature: Optional
     270Key: package (as provided in defpkgdir or extpkgdir)
     271Value: Version that needs to be used in package name (on rpm: name-ver-tag.arch.rpm).
     272Conffile: project
     273Example:
     274
    220275=item B<projtag>
    221276=item B<projver>
Note: See TracChangeset for help on using the changeset viewer.