Changeset 2292 in ProjectBuilder

Timestamp:

Sep 4, 2017, 1:21:22 PM (7 years ago)

Author:

Bruno Cornec

Message:

Moves documentation aruond directories to pod file

Location:

devel/pb-modules

Files:

• etc/pb.yml.pod (modified) (1 diff)
• lib/ProjectBuilder/Env.pm (modified) (1 diff)

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

@@ -1148 +1148 @@
 =item B<pb Directories>
 
- In order to use project-builder.org to build packages for a project, you need to declare certain directories in your configurationfile, and two URLS, as defined in the previous paragraph, linked to them.
+ In order to use project-builder.org to build packages for a project, you need to declare certain directories in your configuration file, and two URLS, as defined in the previous paragraph, linked to them.
+
+ Tree will look like this:
+
+             maint pbdefdir                         PBDEFDIR            dev dir (optional)
+                  |                                                        |
+            ------------------------                                --------------------
+            |                      |                                |                  |
+         pbproj1                pbproj2             PBPROJ       pbproj1           pbproj2   PBPROJDIR
+            |                                                       |
+  ---------------------------------------------                ----------
+  *      *        *       |        |          |                *        *
+ tag    dev    pbconf    ...    pbbuild  pbdelivery PBCONFDIR dev      tag
+  |               |                         |       PBDESTDIR           |
+  ---          ------                    pbrc.yml   PBBUILDDIR       -------
+    |          |    |                                                |     |
+   1.1        dev  tag                                              1.0   1.1                PBDIR
+                    |
+                 -------
+                 |     |
+                1.0   1.1                           PBROOTDIR
+                       |
+               ----------------------------------
+               |          |           |         |
+             pkg1      pbproj1.yml   pbfilter   pbcl
+               |
+        -----------------
+        |      |        |
+       rpm    deb    pbfilter
+
+
+ (*) By default, if no relocation in .pbrc.yml, dev dir is taken in the maint pbdefdir (when appropriate)
+ Names under a pbproj and the corresponding pbconf should be similar
+
 
  The first couple to declare is the pbconfurl and pbconfdir. They declare the location of the repository containing project-builder.org configuration files and the local directory in which they are checked out. They do not need to be hosted in the upstream repository and can be managed completely separately. If pbconfdir is not defined, by default it will be taken as the concatention of pbdefdir and the project name. If that's not the case in your setup, then specify the pbconfdir value

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

@@ -222 +222 @@
 # Detect the root dir for hosting all the content generated with pb
 #
-=pod
-
- Tree will look like this:
-
-             maint pbdefdir                         PBDEFDIR            dev dir (optional)
-                  |                                                        |
-            ------------------------                                --------------------
-            |                      |                                |                  |
-         pbproj1                pbproj2             PBPROJ       pbproj1           pbproj2   PBPROJDIR
-            |                                                       |
-  ---------------------------------------------                ----------
-  *      *        *       |        |          |                *        *
- tag    dev    pbconf    ...    pbbuild  pbdelivery PBCONFDIR dev      tag                  
-  |               |                         |       PBDESTDIR           |
-  ---          ------                    pbrc.yml   PBBUILDDIR       -------
-    |          |    |                                                |     |
-   1.1        dev  tag                                              1.0   1.1                PBDIR
-                    |
-                 -------
-                 |     |
-                1.0   1.1                           PBROOTDIR
-                       |
-               ----------------------------------
-               |          |           |         |
-             pkg1      pbproj1.yml   pbfilter   pbcl
-               |
-        -----------------
-        |      |        |
-       rpm    deb    pbfilter
-
-
- (*) By default, if no relocation in .pbrc.yml, dev dir is taken in the maint pbdefdir (when appropriate)
- Names under a pbproj and the corresponding pbconf should be similar
-
-=back 
-
-=cut
+# Cf Directory structure in pb.yml.pod
 
 my ($pbdefdir) = pb_conf_get_if("pbdefdir");