Changeset 2250 in ProjectBuilder for devel/pb-modules

Timestamp:

Aug 30, 2017, 5:07:29 PM (8 years ago)

Author:

Bruno Cornec

Message:

Doc fixes mostly

Location:

devel/pb-modules

Files:

• etc/pb.yml (modified) (1 diff)
• lib/ProjectBuilder/Conf.pm (modified) (5 diffs)

devel/pb-modules/etc/pb.yml

@@ +1 @@
+%YAML 1.0
+---
 # $Id$
 # 

devel/pb-modules/lib/ProjectBuilder/Conf.pm

@@ -70 +70 @@
 to allow for overwrite to work:
 
+For recent versions of pb (>= 0.15):
+1. /usr/share/pb/pb.yml     - the read-only system conf file provided by install
+2. /etc/pb/pb.yml           - the same global conf file given to the sysadmin in order to make system wide modifications
+3. /path/to/project.yml     - Configuration file for the project we're building for
+4. /vm|vepath/to/.pbrc.yml  - configuration file for VM, VE or RM specific parameters. Cumulative should be orthogonal
+5. $HOME/.pbrc.yml          - user's configuration file
+
+For versions of pb up to 0.14:
 1. /usr/share/pb/pb.conf    - the read-only system conf file provided by install
 2. /etc/pb/pb.conf          - the same global conf file given to the sysadmin in order to make system wide modifications
@@ -75 +83 @@
 4. /(vm|ve|rm)path/to/.pbrc - configuration file for VM, VE or RM specific parameters. Cumulative should be orthogonal
 5. $HOME/.pbrc              - user's configuration file
+
+The format of the configuration file is as follows:
+
+For recent versions of pb (>= 0.15):
+YAML format is now used - The version of the configuration files is 
+
+Supposing the file is called "$ENV{'HOME'}/.pbrc.yml", containing the following:
+
+  $ cat $HOME/.pbrc.yml
+  ---
+    pbver:
+      - pb: 3
+      - default: 1
+    pblist:
+      - pb: 12,25
+
+calling it like this:
+
+  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc.yml","pbver","pblist");
+
+will allow to get the mapping:
+
+  $k1->{'pb'} contains 3
+  $k1->{'default'} contains 1
+  $k2->{'pb'} contains 12,25
+
+For versions of pb up to 0.14:
+An own format was used - The version of the configuration files is 0
+
+key tag = value1,value2,...
+
+Supposing the file is called "$ENV{'HOME'}/.pbrc", containing the following:
+
+  $ cat $HOME/.pbrc
+  pbver pb = 3
+  pbver default = 1
+  pblist pb = 12,25
+
+calling it like this:
+
+  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");
+
+will allow to get the mapping:
+
+  $k1->{'pb'}  contains 3
+  $k1->{'default'} contains 1
+  $k2->{'pb'} contains 12,25
+
+Valid chars for keys and tags are letters, numbers, '-' and '_'.
 
 =over 4
@@ -114 +171 @@
 =item B<pb_conf_cache>
 
-This function caches the configuration file content passed as first parameter into the a hash passed in second parameter
+This function caches the configuration file content passed as first parameter into the hash passed in second parameter
 It returns the modified hash
 Can be used in correlation with the %h hash to store permanently values or not if temporarily.
@@ -203 +260 @@
 If that file doesn't exist, it returns undef.
 
-The format of the configuration file is as follows:
-
-key tag = value1,value2,...
-
-Supposing the file is called "$ENV{'HOME'}/.pbrc", containing the following:
-
-  $ cat $HOME/.pbrc
-  pbver pb = 3
-  pbver default = 1
-  pblist pb = 12,25
-
-calling it like this:
-
-  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");
-
-will allow to get the mapping:
-
-  $k1->{'pb'}  contains 3
-  $k1->{'default'} contains 1
-  $k2->{'pb'} contains 12,25
-
-Valid chars for keys and tags are letters, numbers, '-' and '_'.
-
 The file read is forgotten after its usage. If you want permanent caching of the data, use pb_conf_add then pb_conf_get
 
@@ -340 +374 @@
 
 This function returns a table, corresponding to a set of values queried in the %h hash or undef if it doen't exist. It takes a table of keys as an input parameter.
-
-The format of the configurations file is as follows:
-
-key tag = value1,value2,...
-
-It will gather the values from all the configurations files passed to pb_conf_add, and return the values for the keys
-
-  $ cat $HOME/.pbrc
-  pbver pb = 1
-  pblist pb = 4
-  $ cat $HOME/.pbrc2
-  pbver pb = 3
-  pblist default = 5
-
-calling it like this:
-
-  pb_conf_add("$HOME/.pbrc","$HOME/.pbrc2");
-  my ($k1, $k2) = pb_conf_get_if("pbver","pblist");
-
-will allow to get the mapping:
-
-  $k1->{'pb'} contains 3
-  $k2->{'pb'} contains 4
-
-Valid chars for keys and tags are letters, numbers, '-' and '_'.
 
 =cut