Mar 12, 2019, 11:30:46 PM (16 months ago)
Bruno Cornec

Fix partly the examples to use YAML format instead of previous one

1 edited


  • devel/pb-modules/etc/pb.yml.pod

    r2349 r2375  
    3333 Value: comma separated list of URLs that point to repository files, or packages to install. The values may not include substitutions.
    3434 Conffile: project
    35  Example: addrepo centos-5-x86_64 = file:///prj/extras.repo,http://mirror.centos.org/centos/5.8/extras/x86_64/RPMS/chrpath-0.13-3.el5.centos.x86_64.rpm
     35 Example: addrepo:
     36            centos-5-x86_64: file:///prj/extras.repo,http://mirror.centos.org/centos/5.8/extras/x86_64/RPMS/chrpath-0.13-3.el5.centos.x86_64.rpm
    3738=item B<cachedir>
    4142 Value: Directory to cache temporary content for the relevant pb project.
    4243 Conffile: pb
    43  Example: cachedir rpbootstrap = /var/cache/rpmbootstrap
     44 Example: cachedir:
     45            rpbootstrap: /var/cache/rpmbootstrap
    4547=item B<checkexclude>
    4951 Value: comma separated list of OS (could be from the most generic up to the most specific from ostype, osfamily, os, os-ver, os-ver-arch) that are excluded from the checkssh command (no build made for them). The OS name is generaly used here.
    5052 Conffile: project
    51  Example: checkexclude pkg1 = centos,lsb,solaris
     53 Example: checkexclude:
     54            pkg1: centos,lsb,solaris
    5356=item B<cpandir>
    5760 Value: CPAN Pause directory to upload new modules
    5861 Conffile: pb
    59  Example: cpandir default = incoming
     62 Example: cpandir:
     63            default: incoming
    6165=item B<cpanpasswd>
    6569 Value: CPAN Pause user's password
    6670 Conffile: home
    67  Example: cpanpasswd default = mycomplicatedpwd
     71 Example: cpanpasswd:
     72            default: mycomplicatedpwd
    6974=item B<cpanpause>
    7378 Value: CPAN Pause site to upload new modules
    7479 Conffile: pb
    75  Example: cpanpause default = pause.perl.org
     80 Example: cpanpause:
     81            default: pause.perl.org
    7783=item B<cpansubdir>
    8187 Value: CPAN Pause subdirectory in the user's area to upload into
    8288 Conffile: pb
    83  Example: cpansubdir default = mydir
     89 Example: cpansubdir:
     90            default: mydir
    8592=item B<cpanurl>
    8996 Value: CPAN Pause URL to activate the upload mecanism
    9097 Conffile: pb
    91  Example: cpanurl default = http://pause.perl.org/pause/authenquery
     98 Example: cpanurl:
     99            default: http://pause.perl.org/pause/authenquery
    93101=item B<cpanuser>
    97105 Value: CPAN Pause user
    98106 Conffile: home
    99  Example: cpanuser default = XXX
     107 Example: cpanuser:
     108            default: XXX
    101110=item B<defpkgdir>
    105114 Value: comma 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.
    106115 Conffile: project
    107  Example: defpkgdir mondorescue = mondo,mindi NB: a default value is not really meaningful.
     116 Example: defpkgdir:
     117            mondorescue: mondo,mindi NB: a default value is not really meaningful.
    109119=item B<delivery>
    113123 Value: directory where to deliver packages once built for ftp/web access.
    114124 Conffile: project
    115  Example: delivery mondorescue = prod
     125 Example: delivery:
     126            mondorescue: prod
    117128=item B<dockeropt>
    121132 Value: List of the options to call docker with
    122133 Conffile: project
    123  Example: dockeropt default = --bip=
     134 Example: dockeropt:
     135            default: --bip=
    125137=item B<dockerregistry>
    129141 Value: name of the docker registry to interact with if any
    130142 Conffile: project
    131  Example: dockerregistry mondorescue = localhost:5900/mondorescue
     143 Example: dockerregistry:
     144            mondorescue: localhost:5900/mondorescue
    133146=item B<dockerrepository>
    137150 Value: name of the docker repository to interact with if any. It is mandatory if no dockerregistry is defined.
    138151 Conffile: project
    139  Example: dockerrepository mondorescue = localhost:5000/mondorescue
     152 Example: dockerrepository:
     153            mondorescue: localhost:5000/mondorescue
    141155=item B<extpkgdir>
    145159 Value: comma 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.
    146160 Conffile: project
    147  Example: extpkgdir mondorescue = mondo-doc,mindi-mindibusybox
     161 Example: extpkgdir:
     162            mondorescue: mondo-doc,mindi-mindibusybox
    149164=item B<filteredfiles>
    153168 Value: comma 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.
    154169 Conffile: project
    155  Example: filteredfiles mindi = rootfs/sbin/init,mindi,install.sh,doc/mindi.8
     170 Example: filteredfiles:
     171            mindi: rootfs/sbin/init,mindi,install.sh,doc/mindi.8
    157173=item B<ftp_proxy>
    161177 Value: string indicating the proxy to use
    162178 Conffile: pb
    163  Example: ftp_proxy default = http://example.com:3128/
     179 Example: ftp_proxy:
     180            default: http://example.com:3128/
    165182=item B<http_proxy>
    169186 Value: string indicating the proxy to use
    170187 Conffile: pb
    171  Example: http_proxy default = http://example.com:3128/
     188 Example: http_proxy:
     189            default: http://example.com:3128/
    173191=item B<https_proxy>
    177195 Value: string indicating the proxy to use
    178196 Conffile: pb
    179  Example: https_proxy default = http://example.com:3128/
     197 Example: https_proxy:
     198            default: http://example.com:3128/
    181200=item B<logcmd>
    185204 Value: internal (the application then handles the logging of what it finds useful) or the name of an application to launch to log context (e.g. sos, cfg2html, ...).
    186205 Conffile: pb
    187  Example: logcmd mageia = sos
     206 Example: logcmd:
     207            mageia: sos
    189209=item B<logcmds>
    193213 Value: In case the B<logcmd> command is internal, a comma separated list of the commands whose trace execution is to be captured in order to log context.
    194214 Conffile: pb
    195  Example: logcmds mageia = mount,lsmod,esxcfg-module -l,df -T
     215 Example: logcmds:
     216            mageia: mount,lsmod,esxcfg-module -l,df -T
    197218=item B<logfiles>
    201222 Value: In case the B<logcmd> command is internal, a comma separated list of the files to capture in order to log context.
    202223 Conffile: pb
    203  Example: logfiles mageia = /etc/raidtab,/proc/cmdline,/proc/swaps
     224 Example: logfiles:
     225            mageia: /etc/raidtab,/proc/cmdline,/proc/swaps
    205227=item B<logopt>
    209231 Value: In case the B<logcmd> command is not internal, the options of the B<logcmd> application to launch to log context
    210232 Conffile: pb
    211  Example: logopt mageia = --all
     233 Example: logopt:
     234            mageia: --all
    213236=item B<mkbmbootcmds>
    217240 Value: comma separated list of commands to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target). Their actual path is deduced from the PATH variable.
    218241 Conffile: pb
    219  Example: mkbmbootcmds linux = perl,awk,gawk,dd,grep,uname
     242 Example: mkbmbootcmds:
     243            linux: perl,awk,gawk,dd,grep,uname
    221245=item B<mkbmbootdirs>
    225249 Value: comma separated list of directories to be copied from the original OS to the target boot media tree (works recursively on the target).
    226250 Conffile: pb
    227  Example: mkbmbootdirs linux = /etc/ssh,/etc/udev,/etc/mdadm
     251 Example: mkbmbootdirs:
     252            linux: /etc/ssh,/etc/udev,/etc/mdadm
    229254=item B<mkbmbootfiles>
    233258 Value: comma separated list of files to be copied from the original OS to the target boot media tree (works recursively for directory creation on the target).
    234259 Conffile: pb
    235  Example: mkbmbootfiles linux = /etc/mdadm.conf,/etc/raidtab,/etc/modprobe.conf
     260 Example: mkbmbootfiles:
     261            linux: /etc/mdadm.conf,/etc/raidtab,/etc/modprobe.conf
    237263=item B<mkbmkerneldir>
    241267 Value: path of the directory containing your kernel.
    242268 Conffile: pb
    243  Example: mkbmkerneldir linux = /boot
     269 Example: mkbmkerneldir:
     270            linux: /boot
    245272=item B<mkbmkernelfile>
    249276 Value: full path of the your kernel.
    250277 Conffile: pb
    251  Example: mkbmkernelfile linux = /boot/vmlinuz-specific
     278 Example: mkbmkernelfile:
     279            linux: /boot/vmlinuz-specific
    253281=item B<mkbmkernelnamere>
    257285 Value: Perl Regular Expression allowing to find OS kernel names in the B<kerneldir> directory.
    258286 Conffile: pb
    259  Example: mkbmkerneldir linux = ^linu|^vmlinu|^xen
     287 Example: mkbmkerneldir:
     288            linux: ^linu|^vmlinu|^xen
    261290=item B<mkbmtargetdirs>
    265294 Value: comma separated list of empty directory paths to be created on the target boot media.
    266295 Conffile: pb
    267  Example: mkbmtargetdirs linux = /tmp,/dev
     296 Example: mkbmtargetdirs:
     297            linux: /tmp,/dev
    269299=item B<namingtype>
    273303 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)
    274304 Conffile: project
    275  Example: namingtype ProjectBuilder = perl
     305 Example: namingtype:
     306            ProjectBuilder: perl
    277308=item B<osambiguous>
    281312 Value: comma 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>
    282313 Conffile: pb
    283  Example: osambiguous debian = debian,ubuntu
     314 Example: osambiguous:
     315            debian: debian,ubuntu
    285317=item B<oschkcmd>
    289321 Value: package checker tool.
    290322 Conffile: pb
    291  Example: oschkcmd deb = /usr/bin/lintian
     323 Example: oschkcmd:
     324            deb: /usr/bin/lintian
    293326=item B<oschkopt>
    297330 Value: package checker tool options.
    298331 Conffile: pb
    299  Example: oschkcmd rpm = -i
     332 Example: oschkcmd:
     333            rpm: -i
    301335=item B<oscmd>
    305339 Value: coma separated list of commands that are mandatory on the underlying system
    306340 Conffile: pb
    307  Example: oscmd pb = tar,ls
     341 Example: oscmd:
     342            pb: tar,ls
    309344=item B<oscmdopt>
    313348 Value: come separated list of commands that are optional on the underlying system
    314349 Conffile: pb
    315  Example: oscmd pb = svn2cl,svn,cvs
     350 Example: oscmd:
     351            pb: svn2cl,svn,cvs
    317353=item B<oscodename>
    329365 Value: OS family name (used to group similar distribution for handling)
    330366 Conffile: pb
    331  Example: osfamily debian = du
     367 Example: osfamily:
     368            debian: du
    333370=item B<osins>
    337374 Value: OS command to lauch in order to automatically install packages on it.
    338375 Conffile: pb
    339  Example: osins fedora = sudo yum -y install
     376 Example: osins:
     377            fedora: sudo yum -y install
    341379=item B<oslocalins>
    345383 Value: OS command to lauch in order to automatically install local packages on it.
    346384 Conffile: pb
    347  Example: oslocalins debian = sudo dpkg -i
     385 Example: oslocalins:
     386            debian: sudo dpkg -i
    349388=item B<osmindep>
    353392 Value: comma separated list of packages needed before setupvm|ve can be run. Install them with your distribution in VM or automatically in VE when possible.
    354393 Conffile: pb
    355  Example: osmindep default = perl,sudo,wget,tar,make,gzip
     394 Example: osmindep:
     395            default: perl,sudo,wget,tar,make,gzip
    357397=item B<osnover>
    361401 Value: true|false. True means that this OS has no need to keep the version
    362402 Conffile: pb
    363  Example: osnover gentoo = true
     403 Example: osnover:
     404            gentoo: true
    365406=item B<ospatchcmd>
    369410 Value: package patch command. For RPM is implicit.
    370411 Conffile: pb
    371  Example: ospatchcmd deb = /usr/bin/patch
     412 Example: ospatchcmd:
     413            deb: /usr/bin/patch
    373415=item B<ospatchopt>
    377419 Value: package patch options.
    378420 Conffile: pb
    379  Example: ospatchcmd deb = -s -p1
     421 Example: ospatchcmd:
     422            deb: -s -p1
    381424=item B<ospathcmd-*>
    385428 Value: Full path name of the command mentioned after the '-' for the relative OS
    386429 Conffile: pb
    387  Example: ospathcmd-halt solaris = /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
     430 Example: ospathcmd-halt:
     431            solaris: /usr/sbin/halt, ospathcmd-halt default = /sbin/halt
    389433=item B<osperldep>
    393437 Value: comma 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.
    394438 Conffile: pb
    395  Example: osperldep rhel-5 = Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
     439 Example: osperldep:
     440            rhel-5: Module-Build,File-MimeInfo,File-BaseDir,Mail-Sendmail
    397442=item B<osperlver>
    401446 Value: Version of the perl module that needs to be found on CPAN.
    402447 Conffile: pb
    403  Example: osperlver Date-Manip = 5.54
     448 Example: osperlver:
     449            Date-Manip: 5.54
    405451=item B<ospkg>
    409455 Value: comma separated list of packages that have to be installed in order for pb to be operational in the VE|VM
    410456 Conffile: pb
    411  Example: ospkg rhel-5 = project-builder
     457 Example: ospkg:
     458            rhel-5: project-builder
    413460=item B<ospkgdep>
    417464 Value: comma 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.
    418465 Conffile: pb
    419  Example: ospkgdep rhel-5 = wget,make,ntp,patch,perl-DateManip
     466 Example: ospkgdep:
     467            rhel-5: wget,make,ntp,patch,perl-DateManip
    421469=item B<osrelambfile>
    425473 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.
    426474 Conffile: pb
    427  Example: osrelambfile debian = /etc/debian_version
     475 Example: osrelambfile:
     476            debian: /etc/debian_version
    429478=item B<osrelexpr>
    433482 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)
    434483 Conffile: pb
    435  Example: osrelexpr rhel = Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
     484 Example: osrelexpr:
     485            rhel: Red Hat (?:Enterprise Linux|Linux Advanced Server) .*release ([0-9.]+).* \(
    437487=item B<osrelfile>
    441491 Value: full path name of the file describing non-ambiguously that distribution. There should be a bijection between the file and the distribution name.
    442492 Conffile: pb
    443  Example: osrelfile fedora = /etc/fedora-release
     493 Example: osrelfile:
     494            fedora: /etc/fedora-release
    445496=item B<osremovedotinver>
    449500 Value: true|false. If true, then no '.' (dot) character is kept in the version name of that OS.
    450501 Conffile: pb
    451  Example: osremovedotinver redhat = true
     502 Example: osremovedotinver:
     503            redhat: true
    453505=item B<osrepo>
    457509 Value: comma separated list of packages, yum repo or apt sources.list files to be added to the VE|VM to support package installation of pb
    458510 Conffile: pb
    459  Example: osrepo rpm = ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
     511 Example: osrepo:
     512            rpm: ftp://ftp.project-builder.org/$ddir/$dver/pb.repo
    461514=item B<ossha>
    465518 Value: sha algorithm used br createrepo
    466519 Conffile: pb
    467  Example: ossha fedora-10 = sha1
     520 Example: ossha:
     521            fedora-10: sha1
    469523=item B<ossudoersmode>
    473527 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
    474528 Conffile: pb
    475  Example: ossudoersmode novell = 640
     529 Example: ossudoersmode:
     530            novell: 640
    477532=item B<ossuffix>
    481536 Value: suffix that will be used in the name of the packages created. By default, concatenation of OS name and version.
    482537 Conffile: pb
    483  Example: ossuffix mandriva = mdv
     538 Example: ossuffix:
     539            mandriva: mdv
    485541=item B<ostype>
    489545 Value: build type grouping packages family. This is used internaly by pb to make various handling depending on that build type.
    490546 Conffile: pb
    491  Example: ostype rh = rpm, ostype md = rpm, ostype novell = rpm
     547 Example: ostype:
     548            rh: rpm, ostype md = rpm, ostype novell = rpm
    493550=item B<osupd>
    497554 Value: OS command to lauch in order to automatically update th VM|VE
    498555 Conffile: pb
    499  Example: osupd fedora = sudo yum -y update
     556 Example: osupd:
     557            fedora: sudo yum -y update
    501559=item B<ossueminorrel>
    505563 Value: Should that OS distinguish between its minor version, considering them as different versions or not. Typically for CentOS where .x versions make incompatible changes.
    506564 Conffile: pb
    507  Example: ossueminorrel centos = true
     565 Example: ossueminorrel:
     566            centos: true
    509568=item B<pbadditionalgpg>
    513572 Value: GPG Key (hexadecimal) list of values separated by ',' that needs to be exported for this project. Useful when changing GPG keys and keeping old packages signed with the former key, use that field to give the value of that former key
    514573 Conffile: project
    515  Example: pbadditionalgpg pb = 0x141B9FF237DB9883
     574 Example: pbadditionalgpg:
     575            pb: 0x141B9FF237DB9883
    517577=item B<pbconfurl>
    521581 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
    522582 Conffile: home|project
    523  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
     583 Example: pbconfurl:
     584            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
    525586=item B<pbdefdir>
    529590 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.
    530591 Conffile: home
    531  Example: pbdefdir default = $ENV{'HOME'}/local/pb/projects
     592 Example: pbdefdir:
     593            default: $ENV{'HOME'}/local/pb/projects
    533595=item B<pbgitremote>
    537599 Value: Remote name of the git repository used. The default is origin
    538600 Conffile: home
    539  Example: pbgitremote python-redfish = upstream
     601 Example: pbgitremote:
     602            python-redfish: upstream
    541604=item B<pbgpgcheck>
    545608 Value: Whether the repository file should be generated specifying that gpg checking of the packages is on. Note that failures to sign packages is tolerated by default, which means that signatures can fail making the repository file generated not work. The default is to require gpg checks (value is 1)
    546609 Conffile: project
    547  Example: pbgpgcheck Lintel = 0
     610 Example: pbgpgcheck:
     611            Lintel: 0
    549613=item B<pbinstalltype>
    553617 Value: file or pkg. Indicates how pb will be installed during the setupve|vm phase in the virtual environment|machine, using CPAN files or upstream packages. Only the dev team needs to use file as packages do not yet exist for it. Or when no repository exists to pull project-builder.org from.
    554618 Conffile: pb
    555  Example: pbinstalltype default = pkg
     619 Example: pbinstalltype:
     620            default: pkg
    557622=item B<pbml>
    561626 Value: white space separated list of e-mail adresses used to send announces with the pb announce option.
    562627 Conffile: project
    563  Example: pbml pb = pb-announce@project-builder.org pb-devel@project-builder.org
     628 Example: pbml:
     629            pb: pb-announce@project-builder.org pb-devel@project-builder.org
    565631=item B<pbpackager>
    569635 Value: Firstname Name and e-mail address of the person packaging the software.
    570636 Conffile: project
    571  Example: pbpackager pb = Bruno Cornec <bruno@project-builder.org>
     637 Example: pbpackager:
     638            pb: Bruno Cornec <bruno@project-builder.org>
    573640=item B<pbparallel>
    577644 Value: number of processes to execute in parallel. By default use the number of cores.
    578645 Conffile: pb
    579  Example: pbparallel pb = 12
     646 Example: pbparallel:
     647            pb: 12
    581649=item B<pbpassfile>
    585653 Value: File containing the GPG passphrase that is used to sign packages
    586654 Conffile: home
    587  Example: pbpassfile pb = /users/me/secret/passfile
     655 Example: pbpassfile:
     656            pb: /users/me/secret/passfile
    589658=item B<pbpasspath>
    593662 Value: The directory under which will be found your secret GPG key file.
    594663 Conffile: home
    595  Example: pbpasspath pb = /home/me/.gnupg
     664 Example: pbpasspath:
     665            pb: /home/me/.gnupg
    597667=item B<pbpassphrase>
    601671 Value: The GPG passphrase that is used to sign packages. Putting it in your conf file has security implications.
    602672 Conffile: home
    603  Example: pbpassphrase pb = TheSecretPassPhrase
     673 Example: pbpassphrase:
     674            pb: TheSecretPassPhrase
    605676=item B<pbpbr>
    609680 Value: whatever. As soon as this is defined, then that project is known as using pbr for source epansion.
    610681 Conffile: project
    611  Example: pbpbr python-redfish = 1
     682 Example: pbpbr:
     683            python-redfish: 1
    613685=item B<pbprojdir>
    617689 Value: local directory under which the project is locally exported. NB: a default value is highly interesting here. By default pbdefdir/projectname
    618690 Conffile: home
    619  Example: pbprojdir mondorescue = $ENV{'HOME'}/local/mondorescue
     691 Example: pbprojdir:
     692            mondorescue: $ENV{'HOME'}/local/mondorescue
    621694=item B<pbrepo>
    625698 Value: URL of the server hosting the upstream tar file.
    626699 Conffile: project
    627  Example: pbrepo mondorescue = ftp://ftp.mondorescue.org
     700 Example: pbrepo:
     701            mondorescue: ftp://ftp.mondorescue.org
    629703=item B<pbshowsudo>
    633707 Value: false (by default), meaning that sudo commands executed with pb_system won't be shown in details, but that the associated comment will be used. For security cncerns, you may want to turn it to true in order to see what pb does with sudo to be safe. Turned on by debug flag.
    634708 Conffile: home
    635  Example: pbshowsudo mondorescue = true
     709 Example: pbshowsudo:
     710            mondorescue: true
    637712=item B<pbsmtp>
    641716 Value: FQDN of the mail server to use to send announces. NB: a default value is highly interesting here.
    642717 Conffile: home
    643  Example: pbsmtp mondorescue = localhost
     718 Example: pbsmtp:
     719            mondorescue: localhost
    645721=item B<pbsockscmd>
    649725 Value: name of the command to use to socksify network calls. NB: a default value is highly interesting here.
    650726 Conffile: home
    651  Example: pbsockscmd default = tsocks
     727 Example: pbsockscmd:
     728            default: tsocks
    653730=item B<pbstoponerr>
    657734 Value: false (by default), meaning that commands giving errors will not stop execution of the pb job. For quicker error solving, you may want to turn it to true in order to stop at the first error. Be aware that project-builder.org is not robust enough to work fully correctly with this on. Especially some commands may in a justified way error out, and you still want the process to go on.
    658735 Conffile: home
    659  Example: pbstoponerr mondorescue = true
     736 Example: pbstoponerr:
     737            mondorescue: true
    666744 Value: B<pbprojurl> 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
    667745 Conffile: home|project
    668  Example: pbprojurl linuxcoe = cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pbprojurl pb = svk:////local/pb
     746 Example: pbprojurl:
     747            linuxcoe: cvs+ssh://:ext:user@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe, pbprojurl pb = svk:////local/pb
    670749=item B<pbusesshagent>
    674753 Value: false means that you want pb to create a dedicated SSH key pair to dialog with VM|RM and false that you prefer to use an existing SSH Agent instead and existing keys
    675754 Conffile: pb
    676  Example: pbusesshagent default = false
     755 Example: pbusesshagent:
     756            default: false
    678758=item B<pbwf>
    682762 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.org to not suffer from that. This is valid when packaging for tar files and not CMS.
    683763 Conffile: project
    684  Example: pbwf afio = 1
     764 Example: pbwf:
     765            afio: 1
    686767=item B<pkgtag>
    690771 Value: Tag that needs to be used in package name (on rpm: name-ver-tag.arch.rpm).  Useful when different from the project version B<projtag> and when republishing a package due to package build modification (not code).
    691772 Conffile: project
    692  Example: pkgtag mindi-busybox = 2
     773 Example: pkgtag:
     774            mindi-busybox: 2
    694776=item B<pkgver>
    698780 Value: Version that needs to be used in package name (on rpm: name-ver-tag.arch.rpm). Useful when different from the project version B<projver>.
    699781 Conffile: project
    700  Example: pkgver mindi-busybox = 1.7.3
     782 Example: pkgver:
     783            mindi-busybox: 1.7.3
    702785=item B<projcomponent>
    706789 Value: The component in the distribution repository, e.g. main for debian/ubuntu free software, (or non-free, contrib) or contrib for mandriva non core component e.g.
    707790 Conffile: project
    708  Example: projcomponent Lintel = main
     791 Example: projcomponent:
     792            Lintel: main
    710794=item B<projtag>
    714798 Value: tag that will be used for all packages names (on rpm: name-ver-tag.arch.rpm) in the project. Each package can overwrite it using B<pkgtag>.
    715799 Conffile: project
    716  Example: projtag mondorescue = 1
     800 Example: projtag:
     801            mondorescue: 1
    718803=item B<projver>
    722807 Value: version that will be used for all packages names (on rpm: name-ver-tag.arch.rpm) in the project. Each package can overwrite it using B<pkgver>.
    723808 Conffile: project
    724  Example: projver mondorescue = 2.2.9
     809 Example: projver:
     810            mondorescue: 2.2.9
    726812=item B<rbsconf>
    730816 Value: for mock it's the configuration directory. For rinse it's its configuration file. For rpmbootstrap it's not used yet.
    731817 Conffile: ve
    732  Example: rbsconf default = /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
     818 Example: rbsconf:
     819            default: /etc/mock, rbsconf default = /etc/pb/pb-rinse.conf
    734821=item B<rbsb4pi>
    738825 Value: for mock it's not used. For rinse it's the script to call before doing installation (in order change the mirror location). For rpmbootstrap it's not used yet.
    739826 Conffile: ve
    740  Example: rbsb4pi centos = /home/rinse/bin/before-post-install.sh
     827 Example: rbsb4pi:
     828            centos: /home/rinse/bin/before-post-install.sh
    742830=item B<rbsmirrorsrv>
    746834 Value: URL for the mirror server for setting up a virtual environment
    747835 Conffile: ve
    748  Example: rbsmirrorsrv debian = http://mirrors1.kernel.org/
     836 Example: rbsmirrorsrv:
     837            debian: http://mirrors1.kernel.org/
    750839=item B<rbsmirrorupd>
    754843 Value: Relative path wrt B<rbsmirrorsrv> where updates are located
    755844 Conffile: ve
    756  Example: rbsmirrorupd mageia = ../updates
     845 Example: rbsmirrorupd:
     846            mageia: ../updates
    758848=item B<rbsopt>
    762852 Value: Additional option to pass to the command
    763853 Conffile: ve
    764  Example: rbsopt rpmbootstrap = -k
     854 Example: rbsopt:
     855            rpmbootstrap: -k
    766857=item B<rbspi>
    770861 Value: for mock it's not used. For rinse it's the script to call after doing installation for customization. For rpmbootstrap it's the script to call after doing installation for customization.
    771862 Conffile: ve
    772  Example: rbspi centos = /home/rinse/bin/post-install.sh
     863 Example: rbspi:
     864            centos: /home/rinse/bin/post-install.sh
    774866=item B<rmhost>
    778870 Value: IP address or name of the Remote Machine running the OS mentioned in the key, accessed through ssh.
    779871 Conffile: rm
    780  Example: rmhost default = localhost - rmhost hpux-11.3-ia64 = - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
     872 Example: rmhost:
     873            default: localhost - rmhost hpux-11.3-ia64 = - rmhost mandriva-2010.2-x86_64 = machine1.domain.name
    782875=item B<rmlist>
    786879 Value: list of comma separated OS (under the form of os-ver-arch). The corresponding machines running these distributions are given in the rmpool parameter.
    787880 Conffile: rm
    788  Example: rmlist default = mandriva-2010.2-i386,fedora-14-i386,rhel-6-i386,rhel-5-i386,pensuse-11.3-i386,sles-11-i386,gentoo-nover-i386,debian-5.0-i386,ubuntu-10.10-i386,solaris-10-i386,mandriva-2010.2-x86_64,fedora-14-x86_64,rhel-6-x86_64,rhel-5-x86_64,opensuse-11.3-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-5.0-x86_64,ubuntu-10.10-x86_64,solaris-10-x86_64,hp-ux-11.3-ia64,rhel-5-ia64
     881 Example: rmlist:
     882            default: mandriva-2010.2-i386,fedora-14-i386,rhel-6-i386,rhel-5-i386,pensuse-11.3-i386,sles-11-i386,gentoo-nover-i386,debian-5.0-i386,ubuntu-10.10-i386,solaris-10-i386,mandriva-2010.2-x86_64,fedora-14-x86_64,rhel-6-x86_64,rhel-5-x86_64,opensuse-11.3-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-5.0-x86_64,ubuntu-10.10-x86_64,solaris-10-x86_64,hp-ux-11.3-ia64,rhel-5-ia64
    790884=item B<rmlogin>
    794888 Value: account name to use on the Remote Machine to build packages. Communication is done with ssh.
    795889 Conffile: rm
    796  Example: rmlogin default = pb
     890 Example: rmlogin:
     891            default: pb
    798893=item B<rmmonport>
    802897 Value: TCP port that is used to dialog with the monitor of the Remote Machine, to pass orders.
    803898 Conffile: rm
    804  Example: rmmonport default = 4444
     899 Example: rmmonport:
     900            default: 4444
    806902=item B<rmntp>
    810906 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
    811907 Conffile: rm
    812  Example: rmntp default = 1.pool.ntp.org
     908 Example: rmntp:
     909            default: 1.pool.ntp.org
    814911=item B<rmpath>
    818915 Value: path where to find configuration file for Remote Machines management.
    819916 Conffile: rm
    820  Example: rmpath default = /home/remote
     917 Example: rmpath:
     918            default: /home/remote
    822920=item B<rmport>
    826924 Value: port number to use to communicate with the RM using the SSH protocol. This localport is redirected to the port 22 of the RM.
    827925 Conffile: rm
    828  Example: rmport pb = 2222,rmport mondorescue = 2223
     926 Example: rmport:
     927            pb: 2222,rmport mondorescue = 2223
    830929=item B<rmtmout>
    834933 Value: Time in seconds to wait before interacting with the RM. This may correspond to the time the RM takes to boot.
    835934 Conffile: rm
    836  Example: rmtmout default = 10
     935 Example: rmtmout:
     936            default: 10
    838938=item B<rmtype>
    842942 Value: ssh. For the moment, only ssh is supported as a communication means with RM.
    843943 Conffile: rm
    844  Example: rmrtype default = ssh
     944 Example: rmrtype:
     945            default: ssh
    846947=item B<sshdir>
    850951 Value: dirname into which packages are uploaded on the B<sshhost> machine.
    851952 Conffile: project
    852  Example: sshdir mondorescue = /pub/mondorescue
     953 Example: sshdir:
     954            mondorescue: /pub/mondorescue
    854956=item B<sshhost>
    858960 Value: hostname to connect to in order to deliver packages to the repository server.
    859961 Conffile: project
    860  Example: sshhost mondorescue = ftp.mondorescue.org
     962 Example: sshhost:
     963            mondorescue: ftp.mondorescue.org
    862965=item B<sshlogin>
    866969 Value: login to use when connecting to the repository server B<sshhost> for package delivery. whoami result by default
    867970 Conffile: project
    868  Example: sshlogin mondorescue = mylogin
     971 Example: sshlogin:
     972            mondorescue: mylogin
    870974=item B<sshport>
    874978 Value: port to use when connecting to the repository server B<sshhost> for package delivery. 22 by default.
    875979 Conffile: project
    876  Example: sshport mondorescue = 22
     980 Example: sshport:
     981            mondorescue: 22
    878983=item B<supfiles>
    886991 Value: true (meaning this is a test version, whose tag will be generated automatically, based on 0+date in order to allow regular updates, and still be inferior to tag 1 of the official version, and delivered under the test subdirectory of the ftp server). By default false.
    887992 Conffile: project
    888  Example: testver mondorescue = true
     993 Example: testver:
     994            mondorescue: true
    890996=item B<vedebtype>
    8941000 Value: debootstrap (no other tool to create deb distro based chroot)
    8951001 Conffile: ve
    896  Example: vedebtype default = debootstrap
     1002 Example: vedebtype:
     1003            default: debootstrap
    8981005=item B<velist>
    9021009 Value: list of comma separated OS (under the form of os-ver-arch).
    9031010 Conffile: ve
    904  Example: velist default = centos-4-i386,centos-5-i386,centos-4-x86_64,centos-5-x86_64,debian-5.0-i386,debian-5.0-x86_64,lsb-4.0.1-i386,lsb-4.0.1-x86_64
     1011 Example: velist:
     1012            default: centos-4-i386,centos-5-i386,centos-4-x86_64,centos-5-x86_64,debian-5.0-i386,debian-5.0-x86_64,lsb-4.0.1-i386,lsb-4.0.1-x86_64
    9061014=item B<velogin>
    9101018 Value: account name to use in the VE to build packages.
    9111019 Conffile: ve
    912  Example: velogin default = pb
     1020 Example: velogin:
     1021            default: pb
    9141023=item B<ventp>
    9181027 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
    9191028 Conffile: ve
    920  Example: ventp default = 1.pool.ntp.org
     1029 Example: ventp:
     1030            default: 1.pool.ntp.org
    9221032=item B<vepath>
    9261036 Value: path where to find VEs. Ve will be created and used under that path. For each VE os-ver-arch, it will create a subdirectory tree os/ver/arch below that point.
    9271037 Conffile: ve
    928  Example: vepath default = /home/rpmbootstrap
     1038 Example: vepath:
     1039            default: /home/rpmbootstrap
    9301041=item B<verebuild>
    9341045 Value: true|false. True means that the VE should be rebuild before usage.
    9351046 Conffile: ve
    936  Example: verebuild default = true
     1047 Example: verebuild:
     1048            default: true
    9381050=item B<verpmtype>
    9421054 Value: rpmbootstrap|rinse|mock (different tools to create a chroot environment for RPM based distributions. rpmbootstrap comes with pb. the 2 others are separate projects).
    9431055 Conffile: ve
    944  Example: verpmtype default = rpmbootstrap
     1056 Example: verpmtype:
     1057            default: rpmbootstrap
    9461059=item B<vesnap>
    9501063 Value: true|false. True means that the snapshot of the VE should be used before call to the VE. This snapshot consists of a compressed tar pf the VE. Which means that you will always start from a known state, resulting of a former snapshot operation on the VE. Also speeds up a lot the VM launch operation.
    9511064 Conffile: ve
    952  Example: vesnap default = true
     1065 Example: vesnap:
     1066            default: true
    9541068=item B<vetype>
    9581072 Value: chroot|schroot|docker. There are two different ways of launching a Virtual Environment activity in pb. For the moment only chroot and docker have been tested.
    9591073 Conffile: ve
    960  Example: vetype default = chroot
     1074 Example: vetype:
     1075            default: chroot
    9621077=item B<vmbuildtm>
    9661081 Value: Time in seconds to wait before killing the VM if SSH port already used. This should corresponds to the time to send files, build the project and get packages in the VM.
    9671082 Conffile: project
    968  Example: vmbuildtm default = 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
     1083 Example: vmbuildtm:
     1084            default: 600,vmbuildtm mandriva-2009.0-x86_64 = 1200
    9701086=item B<vmcmd>
    9741090 Value: Command to call to launch the VM emulator.  It can contain some options. Another way to pass options to the VM manager command launcher is by using the PBVMOPT environment variable, which comes in addition to the option vmopt.
    9751091 Conffile: vm
    976  Example: vmcmd default = /usr/bin/kvm
     1092 Example: vmcmd:
     1093            default: /usr/bin/kvm
    9781095=item B<vmhost>
    9821099 Value: hostname to connect to in order to reach the VM through ssh. Generally redirected from a port on localhost.
    9831100 Conffile: vm
    984  Example: vmhost default = localhost
     1101 Example: vmhost:
     1102            default: localhost
    9861104=item B<vmlist>
    9901108 Value: list of comma separated OS (under the form of os-ver-arch).
    9911109 Conffile: vm
    992  Example: vmlist default = asianux-2-i386,asianux-3-i386,mandrake-10.1-i386,mandrake-10.2-i386,mandriva-2006.0-i386,mandriva-2007.0-i386,mandriva-2007.1-i386,mandriva-2008.0-i386,mandriva-2008.1-i386,mandriva-2009.0-i386,mandriva-2009.1-i386,mandriva-2010.0-i386,redhat-7.3-i386,redhat-9-i386,fedora-4-i386,fedora-5-i386,fedora-6-i386,fedora-7-i386,fedora-8-i386,fedora-9-i386,fedora-10-i386,fedora-11-i386,fedora-12-i386,rhel-2.1-i386,rhel-3-i386,rhel-4-i386,rhel-5-i386,suse-10.0-i386,suse-10.1-i386,suse-10.2-i386,opensuse-10.3-i386,opensuse-11.0-i386,opensuse-11.1-i386,opensuse-11.2-i386,sles-9-i386,sles-10-i386,sles-11-i386,gentoo-nover-i386,debian-3.1-i386,debian-4.0-i386,debian-5.0-i386,ubuntu-6.06-i386,ubuntu-7.04-i386,ubuntu-7.10-i386,ubuntu-8.04-i386,ubuntu-8.10-i386,ubuntu-9.04-i386,ubuntu-9.10-i386,solaris-10-i386,asianux-2-x86_64,asianux-3-x86_64,mandriva-2007.0-x86_64,mandriva-2007.1-x86_64,mandriva-2008.0-x86_64,mandriva-2008.1-x86_64,mandriva-2009.0-x86_64,mandriva-2009.1-x86_64,mandriva-2010.0-x86_64,fedora-6-x86_64,fedora-7-x86_64,fedora-8-x86_64,fedora-9-x86_64,fedora-10-x86_64,fedora-11-x86_64,fedora-12-x86_64,rhel-3-x86_64,rhel-4-x86_64,rhel-5-x86_64,suse-10.2-x86_64,opensuse-10.3-x86_64,opensuse-11.0-x86_64,opensuse-11.1-x86_64,opensuse-11.2-x86_64,sles-10-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-4.0-x86_64,debian-5.0-x86_64,ubuntu-7.04-x86_64,ubuntu-7.10-x86_64,ubuntu-8.04-x86_64,ubuntu-8.10-x86_64,ubuntu-9.04-x86_64,ubuntu-9.10-x86_64,solaris-10-x86_64
     1110 Example: vmlist:
     1111            default: asianux-2-i386,asianux-3-i386,mandrake-10.1-i386,mandrake-10.2-i386,mandriva-2006.0-i386,mandriva-2007.0-i386,mandriva-2007.1-i386,mandriva-2008.0-i386,mandriva-2008.1-i386,mandriva-2009.0-i386,mandriva-2009.1-i386,mandriva-2010.0-i386,redhat-7.3-i386,redhat-9-i386,fedora-4-i386,fedora-5-i386,fedora-6-i386,fedora-7-i386,fedora-8-i386,fedora-9-i386,fedora-10-i386,fedora-11-i386,fedora-12-i386,rhel-2.1-i386,rhel-3-i386,rhel-4-i386,rhel-5-i386,suse-10.0-i386,suse-10.1-i386,suse-10.2-i386,opensuse-10.3-i386,opensuse-11.0-i386,opensuse-11.1-i386,opensuse-11.2-i386,sles-9-i386,sles-10-i386,sles-11-i386,gentoo-nover-i386,debian-3.1-i386,debian-4.0-i386,debian-5.0-i386,ubuntu-6.06-i386,ubuntu-7.04-i386,ubuntu-7.10-i386,ubuntu-8.04-i386,ubuntu-8.10-i386,ubuntu-9.04-i386,ubuntu-9.10-i386,solaris-10-i386,asianux-2-x86_64,asianux-3-x86_64,mandriva-2007.0-x86_64,mandriva-2007.1-x86_64,mandriva-2008.0-x86_64,mandriva-2008.1-x86_64,mandriva-2009.0-x86_64,mandriva-2009.1-x86_64,mandriva-2010.0-x86_64,fedora-6-x86_64,fedora-7-x86_64,fedora-8-x86_64,fedora-9-x86_64,fedora-10-x86_64,fedora-11-x86_64,fedora-12-x86_64,rhel-3-x86_64,rhel-4-x86_64,rhel-5-x86_64,suse-10.2-x86_64,opensuse-10.3-x86_64,opensuse-11.0-x86_64,opensuse-11.1-x86_64,opensuse-11.2-x86_64,sles-10-x86_64,sles-11-x86_64,gentoo-nover-x86_64,debian-4.0-x86_64,debian-5.0-x86_64,ubuntu-7.04-x86_64,ubuntu-7.10-x86_64,ubuntu-8.04-x86_64,ubuntu-8.10-x86_64,ubuntu-9.04-x86_64,ubuntu-9.10-x86_64,solaris-10-x86_64
    9941113=item B<vmlogin>
    9981117 Value: account name to use in the VM to build packages. Communication is done with ssh.
    9991118 Conffile: vm
    1000  Example: vmlogin default = pb
     1119 Example: vmlogin:
     1120            default: pb
    10021122=item B<vmmem>
    10061126 Value: Memory size in MB to allocate to the VM.
    10071127 Conffile: vm
    1008  Example: vmmem default = 512
     1128 Example: vmmem:
     1129            default: 512
    10101131=item B<vmmonport>
    10141135 Value: TCP port that is used to dialog with the monitor of the VM, to pass orders such as snapshot. Not really operational yet.
    10151136 Conffile: vm
    1016  Example: vmmonport default = 4444
     1137 Example: vmmonport:
     1138            default: 4444
    10181140=item B<vmntp>
    10221144 Value: NTP server to contact for time accuracy with B<ospathcmd-ntpdate> before building.
    10231145 Conffile: vm
    1024  Example: vmntp default = 1.pool.ntp.org
     1146 Example: vmntp:
     1147            default: 1.pool.ntp.org
    10261149=item B<vmopt>
    10301153 Value: list of options to pass to the VM manager command launcher for that distribution. Another way to pass options to the VM manager command launcher is by using the PBVMOPT environment variable, which comes in addition to his option.
    10311154 Conffile: vm
    1032  Example: vmopt default = -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
     1155 Example: vmopt:
     1156            default: -m 384 -daemonize,vmopt mandriva-2009.0-i386 = -m 256 -daemonize -no-kvm
    10341158=item B<vmpath>
    10381162 Value: path where to find VMs. They will be created and used under that path. For each VM os-ver-arch, it will create a os-ver-arch.qemu file below that point.
    10391163 Conffile: vm
    1040  Example: vmpath default = /home/qemu
     1164 Example: vmpath:
     1165            default: /home/qemu
    10421167=item B<vmport>
    10461171 Value: port number to use to communicate with the VM using the SSH protocol. This localport is redirected to the port 22 of the VM.
    10471172 Conffile: vm
    1048  Example: vmport pb = 2222,vmport mondorescue = 2223
     1173 Example: vmport:
     1174            pb: 2222,vmport mondorescue = 2223
    10501176=item B<vmsize>
    10541180 Value: Size of the VM to create when using the newvm command of pb.
    10551181 Conffile: vm
    1056  Example: vmsize default = 7G
     1182 Example: vmsize:
     1183            default: 7G
    10581185=item B<vmsnap>
    10621189 Value: true|false. True means that the snapshot of the VM called pb should be used. Which means that you will always start from a known state, resulting of a former snapshot operation on the VM. Also speeds up a lot the VM launch operation.
    10631190 Conffile: vm
    1064  Example: vmsnap default = true
     1191 Example: vmsnap:
     1192            default: true
    10661194=item B<vmtmout>
    10701198 Value: Time in seconds to wait before interacting with the VM. This should correspond to the time the VM takes to boot.
    10711199 Conffile: vm
    1072  Example: vmtmout default = 180,vmtmout mandriva-2009.0-x86_64 = 500
     1200 Example: vmtmout:
     1201            default: 180,vmtmout mandriva-2009.0-x86_64 = 500
    10741203=item B<vmtype>
    10781207 Value: qemu|kvm. For the moment, only QEMU or KVM are supported as virtualization technologies.
    10791208 Conffile: vm
    1080  Example: vmtype default = kvm
     1209 Example: vmtype:
     1210            default: kvm
    10821212=item B<webdir>
    10861216 Value: Target directory containing the web content in the project that should be delivered when using the sbx|cms2webssh|pkg command of pb.
    10871217 Conffile: project
    1088  Example: webdir mondorescue = website
     1218 Example: webdir:
     1219            mondorescue: website
    10901221=item B<websshdir>
    10941225 Value: dirname into which content is uploaded on the B<websshhost> machine.
    10951226 Conffile: project
    1096  Example: websshdir mondorescue = /var/www/html
     1227 Example: websshdir:
     1228            mondorescue: /var/www/html
    10981230=item B<websshhost>
    11021234 Value: hostname to connect to in order to deliver content to the Web server.
    11031235 Conffile: project
    1104  Example: websshhost mondorescue = www.mondorescue.org
     1236 Example: websshhost:
     1237            mondorescue: www.mondorescue.org
    11061239=item B<websshlogin>
    11101243 Value: login to use when connecting to the Web server B<websshhost> for content delivery.
    11111244 Conffile: project
    1112  Example: websshlogin mondorescue = mylogin
     1245 Example: websshlogin:
     1246            mondorescue: mylogin
    11141248=item B<websshport>
    11181252 Value: port to use when connecting to the Web server B<websshhost> for content delivery.
    11191253 Conffile: project
    1120  Example: websshport mondorescue = 22
     1254 Example: websshport:
     1255            mondorescue: 22
Note: See TracChangeset for help on using the changeset viewer.