1 |
commit: b926a22a4ce705cb9ddf2bce8253ed8c708d4993 |
2 |
Author: André Erdmann <dywi <AT> mailerd <DOT> de> |
3 |
AuthorDate: Fri Jun 1 15:00:18 2012 +0000 |
4 |
Commit: André Erdmann <dywi <AT> mailerd <DOT> de> |
5 |
CommitDate: Fri Jun 1 15:00:18 2012 +0000 |
6 |
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=b926a22a |
7 |
|
8 |
README and description_fields.conf |
9 |
new file: README |
10 |
new file: description_fields.conf |
11 |
|
12 |
--- |
13 |
README | 51 ++++++++++++++++++++++ |
14 |
description_fields.conf | 107 +++++++++++++++++++++++++++++++++++++++++++++++ |
15 |
2 files changed, 158 insertions(+), 0 deletions(-) |
16 |
|
17 |
diff --git a/README b/README |
18 |
new file mode 100644 |
19 |
index 0000000..8147b52 |
20 |
--- /dev/null |
21 |
+++ b/README |
22 |
@@ -0,0 +1,51 @@ |
23 |
+R overlay -- README |
24 |
+ |
25 |
+== How to use == |
26 |
+ |
27 |
+There is currently no "R overlay" script, only modules that implement functionality. |
28 |
+ |
29 |
+=== Running tests === |
30 |
+ |
31 |
+Real tests are scheduled for July 10 - July 30. |
32 |
+ |
33 |
+In the meantime, there are some test scripts (run_<something>.py,test_<something>.sh) |
34 |
+and a Makefile that provide basic testing. |
35 |
+ |
36 |
+To run them you need to create a directory <root>/examples/packages and |
37 |
+put some R packages into it (expected suffix is .tar.gz), |
38 |
+where <root> is the directory containing this README file. |
39 |
+ |
40 |
+You can then run: |
41 |
+ make <some test> |
42 |
+ where <some test> is |
43 |
+ * test-nop -- tries to import roverlay, but does nothing |
44 |
+ * test-ebuild_creation -- tries to create an ebuild for each package in examples/packages |
45 |
+ * test-ebuild_creation -- tries to create 1000 ebuilds for each package in examples/packages |
46 |
+ * test -- runs all of the above tests |
47 |
+ * dummy -- prints python version in use, run |
48 |
+ make PYVER=2 <some test> or make PYVER=3 <some test> |
49 |
+ use a specific one |
50 |
+ |
51 |
+ or: |
52 |
+ ./test_ebuildcreation.sh [-q] [count] |
53 |
+ -- runs count * "number of packages in examples/packages" |
54 |
+ ebuild creations in one script call. |
55 |
+ Use '-q' to suppress the script output (e.g. ebuilds). |
56 |
+ |
57 |
+ ./run_ebuildcreation.py <packages> |
58 |
+ -- runs ebuild creations for the given packages |
59 |
+ |
60 |
+ |
61 |
+ |
62 |
+ |
63 |
+== Configuration == |
64 |
+ |
65 |
+* main configuration |
66 |
+shell-like syntax (using shlex), TODO |
67 |
+ |
68 |
+* description field configuration |
69 |
+ConfigParser syntax, please see 'description_fields.conf' in this directory. |
70 |
+ |
71 |
+* dependency rules configuration |
72 |
+<scheduled for July 1> |
73 |
+ |
74 |
|
75 |
diff --git a/description_fields.conf b/description_fields.conf |
76 |
new file mode 100644 |
77 |
index 0000000..7702296 |
78 |
--- /dev/null |
79 |
+++ b/description_fields.conf |
80 |
@@ -0,0 +1,107 @@ |
81 |
+# R overlay -- description field definition |
82 |
+# Copyright 2006-2012 Gentoo Foundation |
83 |
+# Distributed under the terms of the GNU General Public License v2 |
84 |
+# |
85 |
+ |
86 |
+# ---------------------------------------------------------------------------- |
87 |
+# |
88 |
+# This file controls how DESCRIPTION fields are used |
89 |
+# It is read in raw mode so that strings like '%var' are not interpolated. |
90 |
+# A per-field section is introduced with [<field name>] and |
91 |
+# contains flags and options. |
92 |
+# |
93 |
+# |
94 |
+# known field options are: |
95 |
+# |
96 |
+# default_value = <some value> |
97 |
+# -- set the default value for this field, |
98 |
+# which implies that any read description data |
99 |
+# will contain this field (with value either |
100 |
+# from the description file or the default one). |
101 |
+# 'Disables' the mandatory flag. |
102 |
+# |
103 |
+# allowed_value = <some value> |
104 |
+# -- declares that this field has a value |
105 |
+# whitelist and adds <some value> to this list. |
106 |
+# |
107 |
+# allowed_values = <some values> |
108 |
+# -- same as allowed_value but witj multiple values |
109 |
+# |
110 |
+# alias_withcase = <aliases>, |
111 |
+# alias = <aliases> |
112 |
+# -- declares case-sensitive field name aliases |
113 |
+# aliases can be used to fix typos as well as |
114 |
+# to remap/merge fields (e.g. Title -> Description) |
115 |
+# |
116 |
+# alias_nocase = <aliases> |
117 |
+# -- declares case-insenstivite field names aliases |
118 |
+# |
119 |
+# |
120 |
+# flags = <flags> |
121 |
+# -- add flags to this field; note that any value-less |
122 |
+# option is interpreted as flag |
123 |
+# |
124 |
+# options with multiple values are read as a <value>[, <value>]* list |
125 |
+# |
126 |
+# and known field flags are: |
127 |
+# joinValues |
128 |
+# -- declares that the field's value is one string even if it |
129 |
+# spans over multiple lines (the lines will be joined with ' ') |
130 |
+# isList |
131 |
+# -- declares that the field's value is a list |
132 |
+# (the default regex for splitting the values is '\s*[,;]{1}\s*') |
133 |
+# |
134 |
+# isWhitespaceList |
135 |
+# -- declares that the field's value is a list |
136 |
+# separated by whitespace. Has no effect if 'isList' is set. |
137 |
+# mandatory |
138 |
+# -- declares that this field has to have an value that evaluates |
139 |
+# to True (value is set and not empty). |
140 |
+# This flag is (effectively) useless in conjunction with |
141 |
+# default_value unless the default value evaluates to False. |
142 |
+# |
143 |
+# ignore |
144 |
+# -- ignore this field entirely |
145 |
+# |
146 |
+# |
147 |
+# Flags are always case-insensitive. |
148 |
+# Note that it is not checked whether a flag is known or not, |
149 |
+# which means you can add anything here. |
150 |
+# |
151 |
+# ---------------------------------------------------------------------------- |
152 |
+ |
153 |
+ |
154 |
+[Description] |
155 |
+joinValues |
156 |
+ |
157 |
+[Title] |
158 |
+joinValues |
159 |
+ |
160 |
+[Package] |
161 |
+joinValues |
162 |
+ |
163 |
+[License] |
164 |
+isList |
165 |
+ |
166 |
+[Version] |
167 |
+mandatory |
168 |
+joinValues |
169 |
+ |
170 |
+[Suggests] |
171 |
+alias_nocase = Suggests, Suggest, %Suggests, Suggets, Recommends |
172 |
+ |
173 |
+[Depends] |
174 |
+alias_nocase = Depends, Dependencies, Dependes, %Depends, Depents, Require, Requires |
175 |
+ |
176 |
+[Imports] |
177 |
+alias_nocase = Imports, Import |
178 |
+ |
179 |
+[LinkingTo] |
180 |
+alias_nocase = LinkingTo, LinkingdTo, LinkinTo |
181 |
+ |
182 |
+[SystemRequirements] |
183 |
+alias_nocase = SystemRequirements, SystemRequirement |
184 |
+ |
185 |
+[OS_Type] |
186 |
+alias_nocase = OS_TYPE |
187 |
+allowed_values = unix |