[GNUnet-SVN] r18837 - gnunet-update/doc

[gnunet]

Author: harsha
Date: 2011-12-26 21:22:36 +0100 (Mon, 26 Dec 2011)
New Revision: 18837

Added:
   gnunet-update/doc/groups.txt
Log:
-documentation

Added: gnunet-update/doc/groups.txt
===================================================================
--- gnunet-update/doc/groups.txt                                (rev 0)
+++ gnunet-update/doc/groups.txt        2011-12-26 20:22:36 UTC (rev 18837)
@@ -0,0 +1,49 @@
+#+TITLE: Groups in gnunet-update
+#+AUTHOR: Sree Harsha Totakura
+#+EMAIL: address@hidden
+
+* Rationale
+  Package groups are used to group certain files in the package. The rationale
+  behind this is to provide the user with a customized installation by allowing
+  the user to select which groups are to be installed.
+
+* Configuration
+  
+  The packager can choose which files in the install-prefix(the directory where
+  the software is installed before packaging) form a group. This information is
+  given to gnunet-update through its configuration files
+
+  Each group has to have a group name which has to be indicated in the
+  configuration file under a section whose name should start with `GROUP:'. The
+  section may contain an option `MATCH' which is a comma separated listing of
+  glob file patterns. If relative paths are used in patterns they will be
+  evaluated relative to the install-prefix directory. Group sections without
+  `MATCH' option are ignored
+
+  For example, the configuration for packaging the files `bin/group1-binary',
+  `1ib/group1-lib.so.0.0.0' and `/lib/group1-lib.so.0' under the package
+  `group1' should be as follows:
+#+BEGIN_EXAMPLE
+  [GROUP:group1]
+  MATCH = bin/group1-binary,
+          1ib/group1-lib.so.0.0.0,
+          /lib/group1-lib.so.0
+#+END_EXAMPLE
+
+  Important: The comma seperated values for `MATCH' option should should adhere
+  to the style specified in 
[[http://tools.ietf.org/html/rfc822.html#section-3.1][RFC 822(section 3.1.1: 
Long Header Fields)]]
+
+* Predefined Groups
+
+  Predefined groups are groups with special behavior. They may influence
+  packaging, installation and updating.
+
+  For now, the following predefined groups are defined:
+    * IGNORE
+
+** IGNORE Group
+   This group is used to specify the files which are to be ignored(while
+   packaging). Any file matching to the pattern specified in this group will be
+   ignored. Neither the file nor its dependencies(incase it is an executable
+   file) are packaged
+