Zorba

Merge lp:~paul-lucas/zorba/pjl-misc into lp:zorba

  1. pjl-misc
  2. Merge into trunk
Proposed by Paul J. Lucas
Status: Merged
Approved by: Paul J. Lucas
Approved revision: 11469
Merged at revision: 11704
Proposed branch: lp:~paul-lucas/zorba/pjl-misc
Merge into: lp:zorba
Diff against target: 345 lines (+62/-62)
3 files modified
bin/zorbacmd_args.cpp (+39/-39)
modules/json/json-csv.jq (+1/-1)
test/iterplans/apitest_args.cpp (+22/-22)
To merge this branch: bzr merge lp:~paul-lucas/zorba/pjl-misc
Reviewer Review Type Date Requested Status
Matthias Brantner Approve
Paul J. Lucas Approve
Review via email: mp+209559@code.launchpad.net

Commit message

More help message clean-up.

Description of the change

More help message clean-up.

To post a comment you must log in.
lp:~paul-lucas/zorba/pjl-misc updated
11469. By Paul J. Lucas

Cosmetic change.

Revision history for this message
Paul J. Lucas (paul-lucas) :
review: Approve
Revision history for this message
Matthias Brantner (matthias-brantner) :
review: Approve
Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :

Validation queue starting for the following merge proposals:
https://code.launchpad.net/~paul-lucas/zorba/pjl-misc/+merge/209559

Progress dashboard at http://jenkins.zorba.io:8180/view/ValidationQueue

Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :

Validation queue succeeded - proposal merged!

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'bin/zorbacmd_args.cpp'
2--- bin/zorbacmd_args.cpp 2014-03-04 03:22:16 +0000
3+++ bin/zorbacmd_args.cpp 2014-03-05 23:44:30 +0000
4@@ -78,30 +78,30 @@
5
6 ////////// b //////////////////////////////////////////////////////////////
7
8- HELP_OPT( "--base-uri" )
9+ HELP_OPT( "--base-uri <uri>" )
10 "Set the base URI property of the static context.\n\n"
11
12- HELP_OPT( "--boundary-space" )
13- "Set the boundary-space policy ('strip' or 'preserve') in the static context.\n\n"
14+ HELP_OPT( "--boundary-space {strip|preserve}" )
15+ "Set the boundary-space policy in the static context.\n\n"
16
17 HELP_OPT( "--byte-order-mark" )
18 "Set the byte-order-mark for the serializer.\n\n"
19
20 ////////// c //////////////////////////////////////////////////////////////
21
22- HELP_OPT( "--classpath" )
23- "JVM classpath to be used by modules using Java implementations\n\n"
24+ HELP_OPT( "--classpath <path>" )
25+ "Set the JVM classpath to be used by modules using Java implementations.\n\n"
26
27 HELP_OPT( "--compile-only" )
28 "Only compile (don't execute).\n\n"
29
30- HELP_OPT( "--compile-plan," )
31+ HELP_OPT( "--compile-plan" )
32 "Do not execute the query; just compile it and save the execution plan in the file specified with the -o option.\n\n"
33
34- HELP_OPT( "--construction-mode" )
35- "Set the construction mode ('strip' or 'preserve') in the static context.\n\n"
36+ HELP_OPT( "--construction-mode {strip|preserve}" )
37+ "Set the construction mode in the static context.\n\n"
38
39- HELP_OPT( "--context-item" )
40+ HELP_OPT( "--context-item <item>" )
41 "Set the context item to the XML document in a given file.\n\n"
42
43 ////////// d //////////////////////////////////////////////////////////////
44@@ -111,21 +111,21 @@
45 "Launch the Zorba debugger server and connect to a DBGP-enabled debugger client.\n\n"
46 #endif /* ZORBA_WITH_DEBUGGER */
47
48- HELP_OPT( "--debug-file" )
49+ HELP_OPT( "--debug-file <file>" )
50 "Sets the file to write developer debugging information to.\n\n"
51
52- HELP_OPT( "--debug-stream <stream>" )
53+ HELP_OPT( "--debug-stream {1|cout|stdout|2|cerr|stderr}" )
54 "Sets the stream to write developer debugging information to.\n\n"
55
56 #ifdef ZORBA_WITH_DEBUGGER
57- HELP_OPT( "--debug-host, -h" )
58- "The host where the DBGP-enabled debugger client listens for connections. Defaults to: 127.0.0.1\n\n"
59+ HELP_OPT( "--debug-host, -h <host>" )
60+ "The host where the DBGP-enabled debugger client listens for connections; default: 127.0.0.1.\n\n"
61
62- HELP_OPT( "--debug-port, -p" )
63- "The port on which the DBGP-enabled debugger client listens for connections. Defaults to: 28028\n\n"
64+ HELP_OPT( "--debug-port, -p <port>" )
65+ "The port on which the DBGP-enabled debugger client listens for connections; defaults: 28028.\n\n"
66 #endif /* ZORBA_WITH_DEBUGGER */
67
68- HELP_OPT( "--default-collation" )
69+ HELP_OPT( "--default-collation <collation>" )
70 "Add the given collation and set the value of the default collation in the static context to the given collation.\n\n"
71
72 HELP_OPT( "--disable-http-resolution" )
73@@ -139,8 +139,8 @@
74 HELP_OPT( "--execute-plan" )
75 "Do not compile the query; instead load the execution plan from the file specified by the -f -q options (or by any file specified without any other argument), and execute the loaded plan.\n\n"
76
77- HELP_OPT( "--external-variable, -e" )
78- "Provide the value for a variable given a file (name=file) or a value (name:=value)\n\n"
79+ HELP_OPT( "--external-variable, -e <name>{=file|:=<value>}" )
80+ "Set the value for an externsl variable.\n\n"
81
82 ////////// f //////////////////////////////////////////////////////////////
83
84@@ -149,7 +149,7 @@
85
86 ////////// h //////////////////////////////////////////////////////////////
87
88- HELP_OPT( "--help, -h" )
89+ HELP_OPT( "--help" )
90 "Print this help message.\n\n"
91
92 ////////// i //////////////////////////////////////////////////////////////
93@@ -163,8 +163,8 @@
94 HELP_OPT( "--inline-udf" )
95 "Inline user-defined functions.\n\n"
96
97- HELP_OPT( "--iterator-tree <format>" )
98- "Print the iterator tree in in one of DOT, JSON, or XML formats.\n\n"
99+ HELP_OPT( "--iterator-tree {dot|json|xml}>" )
100+ "Print the iterator tree in the given format.\n\n"
101
102 ////////// j //////////////////////////////////////////////////////////////
103
104@@ -176,7 +176,7 @@
105 HELP_OPT( "--lib-module, -l" )
106 "Query compiler option to treat the query as a library module. If this is set --compile-only option is also set to true.\n\n"
107
108- HELP_OPT( "--lib-path" )
109+ HELP_OPT( "--lib-path <path>" )
110 "Library path (list of directories) where Zorba will look for dynamic libraries (e.g., module external function implementations.\n\n"
111
112 HELP_OPT( "--loop-hosting" )
113@@ -184,10 +184,10 @@
114
115 ////////// m //////////////////////////////////////////////////////////////
116
117- HELP_OPT( "--max-udf-call-depth" )
118+ HELP_OPT( "--max-udf-call-depth <depth>" )
119 "Maximum stack depth of user-defined function calls.\n\n"
120
121- HELP_OPT( "--module-path" )
122+ HELP_OPT( "--module-path <path>" )
123 "Path (list of directories) to add to both the URI and Library paths.\n\n"
124
125 HELP_OPT( "--multiple, -m" )
126@@ -212,17 +212,17 @@
127 HELP_OPT( "--omit-xml-declaration, -r" )
128 "Omit the XML declaration from the result.\n\n"
129
130- HELP_OPT( "--optimization-level, -O" )
131- "Optimization level for the query compiler [0-2], default: 1\n\n"
132+ HELP_OPT( "--optimization-level, -O {0|1|2}>" )
133+ "Optimization level for the query compiler, default: 1.\n\n"
134
135- HELP_OPT( "--option" )
136+ HELP_OPT( "--option <option>=<value>" )
137 "Set an XQuery option in the static context. The QName of the option is passed as a string in the notation by James Clark (i.e. {namespace}localname). For example, --option {http://zorba.io/}option=value\n\n"
138
139- HELP_OPT( "--ordering-mode" )
140- "Set the ordering mode ('ordered' or 'unordered') in the static context.\n\n"
141+ HELP_OPT( "--ordering-mode {ordered|unordered}" )
142+ "Set the ordering mode in the static context.\n\n"
143
144 #ifdef ZORBA_WITH_FILE_ACCESS
145- HELP_OPT( "--output-file, -o" )
146+ HELP_OPT( "--output-file, -o <file>" )
147 "Write the result to the given file.\n\n"
148 #endif /* ZORBA_WITH_FILE_ACCESS */
149
150@@ -271,8 +271,8 @@
151
152 ////////// s //////////////////////////////////////////////////////////////
153
154- HELP_OPT( "--serialization-parameter, -z" )
155- "Set serialization parameter in the form of a parameter=value pair (see http://www.w3.org/TR/xslt-xquery-serialization/#serparam, e.g.: -z method=xhtml -z doctype-system=DTD/xhtml1-strict.dtd -z indent=yes).\n\n"
156+ HELP_OPT( "--serialization-parameter, -z <name>=<value>" )
157+ "Set serialization parameter (see http://www.w3.org/TR/xslt-xquery-serialization/#serparam, e.g.: -z method=xhtml -z doctype-system=DTD/xhtml1-strict.dtd -z indent=yes).\n\n"
158
159 HELP_OPT( "--serialize-html" )
160 "Serialize the result as HTML.\n\n"
161@@ -293,19 +293,19 @@
162 "Print the iterator plan with stable IDs.\n\n"
163
164 #ifndef ZORBA_NO_FULL_TEXT
165- HELP_OPT( "--stop-words" )
166+ HELP_OPT( "--stop-words <uri>:=<value>" )
167 "Mapping specifying a stop-words URI to another.\n\n"
168
169 ////////// t //////////////////////////////////////////////////////////////
170
171- HELP_OPT( "--thesaurus" )
172+ HELP_OPT( "--thesaurus <uri>:=<value>" )
173 "Mapping specifying a thesaurus URI to another.\n\n"
174 #endif /* ZORBA_NO_FULL_TEXT */
175
176 HELP_OPT( "--timing, -t" )
177 "Print timing information. In case of multiple queries, the timing information is provided per query. Both wallclock time and user time (which excludes I/O, network delays and other kernel waits) are shown.\n\n"
178
179- HELP_OPT( "--timeout" )
180+ HELP_OPT( "--timeout <seconds>" )
181 "Specify a timeout in seconds. After the specified time, the execution of the query will be aborted.\n\n"
182
183 HELP_OPT( "--trace-parsing" )
184@@ -330,7 +330,7 @@
185
186 ////////// u //////////////////////////////////////////////////////////////
187
188- HELP_OPT( "--uri-path" )
189+ HELP_OPT( "--uri-path <path>" )
190 "URI path (list of directories) added to the built-in URI resolver, i.e. where to find modules/schemas to import.\n\n"
191
192 ////////// v //////////////////////////////////////////////////////////////
193@@ -476,12 +476,12 @@
194 PARSE_ARG( "--debug-stream" );
195 string val( ARG_VAL );
196 to_lower( val );
197- if ( val == "1" || val == "stdout" || val == "cout" )
198+ if ( val == "1" || val == "cout" || val == "stdout" )
199 z_props.setDebugStream( cout );
200- else if ( val == "2" || val == "stderr" || val == "cerr" )
201+ else if ( val == "2" || val == "cerr" || val == "stderr" )
202 z_props.setDebugStream( cerr );
203 else {
204- error = "--debug-stream argument must be one of: 1, stdout, cout, 2, stderr, or cerr.\n";
205+ error = "--debug-stream argument must be one of: 1, cout, stdout, 2, cerr, or stderr.\n";
206 break;
207 }
208 }
209
210=== modified file 'modules/json/json-csv.jq'
211--- modules/json/json-csv.jq 2014-01-16 23:09:20 +0000
212+++ modules/json/json-csv.jq 2014-03-05 23:44:30 +0000
213@@ -246,7 +246,7 @@
214 : the field names are taken from the first JSON object
215 : and the order of the fields is implementation dependent.
216 : If this option is set,
217- : the fields are serielized in the order they are in the array.
218+ : the fields are serialized in the order they are in the array.
219 : In either case,
220 : every JSON object must have the same keys as the first object.
221 : </dd>
222
223=== modified file 'test/iterplans/apitest_args.cpp'
224--- test/iterplans/apitest_args.cpp 2014-03-01 15:34:04 +0000
225+++ test/iterplans/apitest_args.cpp 2014-03-05 23:44:30 +0000
226@@ -49,7 +49,7 @@
227 ////////// c //////////////////////////////////////////////////////////////
228
229 HELP_OPT( "--compile-only" )
230- "Only compile (don't execute)\n\n"
231+ "Only compile (don't execute).\n\n"
232
233 ////////// d //////////////////////////////////////////////////////////////
234
235@@ -58,18 +58,18 @@
236 "Launch the Zorba debugger server and connect to a DBGP-enabled debugger client.\n\n"
237 #endif /* ZORBA_WITH_DEBUGGER */
238
239- HELP_OPT( "--debug-file" )
240+ HELP_OPT( "--debug-file <file>" )
241 "Sets the file to write developer debugging information to.\n\n"
242
243- HELP_OPT( "--debug-stream <stream>" )
244+ HELP_OPT( "--debug-stream {1|cout|stdout|2|cerr|stderr}" )
245 "Sets the stream to write developer debugging information to.\n\n"
246
247 #ifdef ZORBA_WITH_DEBUGGER
248- HELP_OPT( "--debug-host, -h" )
249- "The host where the DBGP-enabled debugger client listens for connections. Defaults to: 127.0.0.1\n\n"
250+ HELP_OPT( "--debug-host, -h <host>" )
251+ "The host where the DBGP-enabled debugger client listens for connections; default: 127.0.0.1.\n\n"
252
253- HELP_OPT( "--debug-port, -p" )
254- "The port on which the DBGP-enabled debugger client listens for connections. Defaults to: 28028\n\n"
255+ HELP_OPT( "--debug-port, -p <port>" )
256+ "The port on which the DBGP-enabled debugger client listens for connections; default: 28028.\n\n"
257 #endif /* ZORBA_WITH_DEBUGGER */
258
259 ////////// e //////////////////////////////////////////////////////////////
260@@ -77,8 +77,8 @@
261 HELP_OPT( "--execute-plan" )
262 "Do not compile the query; instead load the execution plan from the file specified by the -f -q options (or by any file specified without any other argument), and execute the loaded plan.\n\n"
263
264- HELP_OPT( "--external-var, -x" )
265- "Provide the value for a variable given a file (name=file) or a value (name:=value)\n\n"
266+ HELP_OPT( "--external-var, -x <name>{=<file>|:=<value>}" )
267+ "Sets the value of an external variable.\n\n"
268
269 ////////// i //////////////////////////////////////////////////////////////
270
271@@ -98,7 +98,7 @@
272 HELP_OPT( "--lib-module, -l" )
273 "Query compiler option to treat the query as a library module. If this is set --compile-only option is also set to true.\n\n"
274
275- HELP_OPT( "--lib-path" )
276+ HELP_OPT( "--lib-path <path>" )
277 "Library path (list of directories) where Zorba will look for dynamic libraries (e.g., module external function implementations.\n\n"
278
279 HELP_OPT( "--loop-hosting" )
280@@ -106,10 +106,10 @@
281
282 ////////// m //////////////////////////////////////////////////////////////
283
284- HELP_OPT( "--max-udf-call-depth" )
285+ HELP_OPT( "--max-udf-call-depth <depth>" )
286 "Maximum stack depth of user-defined function calls.\n\n"
287
288- HELP_OPT( "--module-path" )
289+ HELP_OPT( "--module-path <path>" )
290 "Path (list of directories) to add to both the URI and Library paths.\n\n"
291
292 ////////// n //////////////////////////////////////////////////////////////
293@@ -125,11 +125,11 @@
294
295 ////////// o //////////////////////////////////////////////////////////////
296
297- HELP_OPT( "--optimization-level, -O" )
298- "Optimization level for the query compiler [0-2], default: 1\n\n"
299+ HELP_OPT( "--optimization-level, -O {0|1|2}" )
300+ "Optimization level for the query compiler; default: 1.\n\n"
301
302 #ifdef ZORBA_WITH_FILE_ACCESS
303- HELP_OPT( "--output-file, -o" )
304+ HELP_OPT( "--output-file, -o <file>" )
305 "Write the result to the given file.\n\n"
306 #endif /* ZORBA_WITH_FILE_ACCESS */
307
308@@ -170,13 +170,13 @@
309
310 ////////// q //////////////////////////////////////////////////////////////
311
312- HELP_OPT( "--query, -q" )
313- "Query test or file URI (file://...)\n\n"
314+ HELP_OPT( "--query, -q <query>" )
315+ "Query test or file URI (file://...).\n\n"
316
317 ////////// s //////////////////////////////////////////////////////////////
318
319- HELP_OPT( "--serialization-parameter, -z" )
320- "Set serialization parameter in the form of a parameter=value pair (see http://www.w3.org/TR/xslt-xquery-serialization/#serparam, e.g.: -z method=xhtml -z doctype-system=DTD/xhtml1-strict.dtd -z indent=yes).\n\n"
321+ HELP_OPT( "--serialization-parameter, -z <name>=<value>" )
322+ "Set serialization parameter (see http://www.w3.org/TR/xslt-xquery-serialization/#serparam, e.g.: -z method=xhtml -z doctype-system=DTD/xhtml1-strict.dtd -z indent=yes).\n\n"
323
324 ////////// t //////////////////////////////////////////////////////////////
325
326@@ -197,8 +197,8 @@
327 "Trace the translator.\n\n"
328 #endif /* NDEBUG */
329
330- HELP_OPT( "--tz" )
331- "Set implicit time zone (in minutes.\n\n"
332+ HELP_OPT( "--tz <minutes>" )
333+ "Set implicit time zone (in minutes).\n\n"
334
335 ////////// u //////////////////////////////////////////////////////////////
336
337@@ -374,7 +374,7 @@
338
339 ////////// h //////////////////////////////////////////////////////////////
340
341- else if ( IS_OPT( "--help", "-h" ) ) {
342+ else if ( IS_LONG_OPT( "--help" ) ) {
343 cout << "Zorba NoSQL Query Processor, Version: "
344 << Zorba::version() << '\n'
345 << "Available options:\n\n"

Subscribers

People subscribed via source and target branches