Drizzle

Merge lp:~stewart/drizzle/docs-improvements-1 into lp:drizzle

  1. docs-improvements-1
  2. Merge into 7.2
Proposed by Stewart Smith
Status: Merged
Merged at revision: 2630
Proposed branch: lp:~stewart/drizzle/docs-improvements-1
Merge into: lp:drizzle
Diff against target: 567 lines (+87/-78)
2 files modified
docs/configuration/drizzled.rst (+87/-76)
drizzled/drizzled.cc (+0/-2)
To merge this branch: bzr merge lp:~stewart/drizzle/docs-improvements-1
Reviewer Review Type Date Requested Status
Stewart Smith (community) Approve
Drizzle Trunk Pending
Review via email: mp+151116@code.launchpad.net

Description of the change

some docs improvements

To post a comment you must log in.
Revision history for this message
Stewart Smith (stewart) wrote :

approving, all better than what was(n't) there.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'docs/configuration/drizzled.rst'
2--- docs/configuration/drizzled.rst 2013-02-28 06:25:08 +0000
3+++ docs/configuration/drizzled.rst 2013-02-28 22:22:28 +0000
4@@ -23,14 +23,10 @@
5
6 Display this help and exit.
7
8-.. option:: --help-extended
9-
10- Display this help and exit after initializing plugins.
11-
12 .. option:: --user, -u ARG
13
14 :Default:
15- :Variable:
16+ :Variable:
17
18 Run drizzled daemon as user.
19
20@@ -49,21 +45,21 @@
21 .. option:: --config-dir DIR
22
23 :Default: :file:`/etc/drizzle`
24- :Variable:
25+ :Variable:
26
27 Base location for config files.
28
29 .. option:: --defaults-file FILE
30-
31+
32 :Default:
33- :Variable:
34+ :Variable:
35
36 Configuration file to use.
37
38 .. option:: --no-defaults
39
40 :Default:
41- :Variable:
42+ :Variable:
43
44 Configuration file defaults are not used if no-defaults is set.
45
46@@ -75,11 +71,11 @@
47 .. option:: --plugin-add LIST
48
49 :Default:
50- :Variable:
51+ :Variable:
52
53 Optional comma separated list of plugins to load at startup in addition
54 to the default list of plugins.
55-
56+
57 For example::
58
59 --plugin-add=crc32,console,pbxt
60@@ -87,14 +83,14 @@
61 .. option:: --plugin-dir DIR
62
63 :Default:
64- :Variable:
65+ :Variable:
66
67 Directory for plugins.
68
69 .. option:: --plugin-load LIST
70
71 :Default: See :ref:`default_plugins`
72- :Variable:
73+ :Variable:
74
75 Optional comma separated list of plugins to load at starup instead of
76 the default plugin load list. This completely replaces the whole list.
77@@ -102,7 +98,7 @@
78 .. option:: --plugin-remove LIST
79
80 :Default:
81- :Variable:
82+ :Variable:
83
84 Optional comma separated list of plugins to not load at startup.
85 Effectively removes a plugin from the list of plugins to be loaded.
86@@ -118,10 +114,13 @@
87
88 .. option:: --replicate-query
89
90- :Default:
91+ :Default: false
92 :Variable: ``replicate_query``
93-
94- Include the SQL query in replicated protobuf messages.
95+
96+ Include the SQL query in replicated protobuf messages. This can be useful
97+ for tracking back what SQL query caused what row operations to occur
98+ at the expense of increased size of the replication log (possibly even
99+ doubling it for some operations).
100
101 .. option:: --transaction-message-threshold
102
103@@ -130,6 +129,13 @@
104
105 Max message size written to transaction log, valid values 131072 - 1048576 bytes.
106
107+ If a transaction produres more than ``transaction-message-threshold`` bytes
108+ of data for replication, the transaction is segmented in the replication
109+ stream. if ``transaction-message-threshold`` is met and in the event of
110+ ROLLBACK, the slave will have to do slightly more work as it may have
111+ already started applying the transaction and will also have to execute
112+ ROLLBACK.
113+
114 .. _drizzled_kernel_options:
115
116 Kernel Options
117@@ -178,7 +184,7 @@
118 .. option:: --chroot, -r ARG
119
120 :Default:
121- :Variable:
122+ :Variable:
123
124 Chroot drizzled daemon during startup.
125
126@@ -199,7 +205,7 @@
127 .. option:: --core-file
128
129 :Default:
130- :Variable:
131+ :Variable:
132
133 Write core on errors.
134
135@@ -217,13 +223,6 @@
136
137 Set the default storage engine for tables.
138
139-.. option:: --default-time-zone ARG
140-
141- :Default:
142- :Variable:
143-
144- Set the default time zone.
145-
146 .. option:: --disable-optimizer-prune
147
148 :Default:
149@@ -236,21 +235,21 @@
150
151 :Default: 4
152 :Variable: ``div_precision_increment``
153-
154+
155 Precision of the result of '/' operator will be increased on that value.
156
157 .. We should really remove --exit-info as an option
158 .. option:: --exit-info, -T ARG
159
160 :Default:
161- :Variable:
162+ :Variable:
163
164 Used for debugging; Use at your own risk!
165
166 .. option:: --gdb
167
168 :Default:
169- :Variable:
170+ :Variable:
171
172 Set up signals usable for debugging.
173
174@@ -264,7 +263,7 @@
175 .. option:: --join-buffer-constraint ARG
176
177 :Default: 0
178- :Variable:
179+ :Variable:
180
181 A global constraint for join-buffer-size for all clients, cannot be set lower
182 than :option:`--join-buffer-size`. Setting to 0 means unlimited.
183@@ -286,7 +285,7 @@
184 .. option:: --log-warnings, -W ARG
185
186 :Default:
187- :Variable:
188+ :Variable:
189
190 Log some not critical warnings to the log file.
191
192@@ -301,9 +300,9 @@
193 .. option:: --max-connect-errors ARG
194
195 :Default: 10
196- :Variable:
197+ :Variable:
198
199- If there is more than this number of interrupted connections from a host
200+ If there is more than this number of interrupted connections from a host
201 this host will be blocked from further connections.
202
203 .. option:: --max-error-count ARG
204@@ -325,7 +324,7 @@
205 :Default: 2147483647
206 :Variable: ``max_join_size``
207
208- Joins that are probably going to read more than max_join_size records return
209+ Joins that are probably going to read more than max_join_size records return
210 an error.
211
212 .. option:: --max-length-for-sort-data SIZE
213@@ -348,7 +347,7 @@
214 :Default: 1024
215 :Variable: ``max_sort_length``
216
217- The number of bytes to use when sorting BLOB or TEXT values (only the first
218+ The number of bytes to use when sorting BLOB or TEXT values (only the first
219 max_sort_length bytes of each value are used; the rest are ignored).
220
221 .. option:: --max-write-lock-count ARG
222@@ -375,13 +374,13 @@
223 Maximum depth of search performed by the query optimizer. Values larger than
224 the number of relations in a query result in better query plans, but take
225 longer to compile a query. Smaller values than the number of tables in a
226- relation result in faster optimization, but may produce very bad query plans.
227+ relation result in faster optimization, but may produce very bad query plans.
228 If set to 0, the system will automatically pick a reasonable value; if set to
229 MAX_TABLES+2, the optimizer will switch to the original find_best (used for
230 testing/comparison).
231
232 .. option:: --pid-file FILE
233-
234+
235 :Default:
236 :Variable: ``pid_file``
237
238@@ -391,7 +390,7 @@
239 .. option:: --port-open-timeout ARG
240
241 :Default: 0
242- :Variable:
243+ :Variable:
244
245 Maximum time in seconds to wait for the port to become free.
246 A value of 0 means not to wait.
247@@ -427,7 +426,7 @@
248 .. option:: --read-buffer-constraint ARG
249
250 :Default: 0
251- :Variable:
252+ :Variable:
253
254 A global constraint for read-buffer-size for all clients, cannot be set lower
255 than --read-buffer-size. Setting to 0 means unlimited.
256@@ -453,7 +452,7 @@
257 .. option:: --read-rnd-constraint ARG
258
259 :Default: 0
260- :Variable:
261+ :Variable:
262
263 A global constraint for read-rnd-buffer-size for all clients, cannot be set
264 lower than --read-rnd-buffer-size. Setting to 0 means unlimited.
265@@ -485,20 +484,20 @@
266 .. option:: --skip-stack-trace
267
268 :Default:
269- :Variable:
270+ :Variable:
271
272 Don't print a stack trace on failure.
273
274 .. option:: --sort-buffer-constraint ARG
275
276 :Default: 0
277- :Variable:
278+ :Variable:
279
280 A global constraint for sort-buffer-size for all clients, cannot be set lower
281 than --sort-buffer-size. Setting to 0 means unlimited.
282
283 .. option:: --sort-buffer-size SIZE
284-
285+
286 :Default: 2097144
287 :Variable: ``sort_buffer_size``
288
289@@ -507,7 +506,7 @@
290 .. option:: --symbolic-links, -s
291
292 :Default:
293- :Variable:
294+ :Variable:
295
296 Enable symbolic link support.
297
298@@ -589,7 +588,7 @@
299
300 :Scope: Global
301 :Dynamic: No
302- :Option:
303+ :Option:
304
305 If statements are auto-committed.
306
307@@ -653,11 +652,17 @@
308
309 * ``error_count``
310
311- :Scope: Global
312+ :Scope: Session
313 :Dynamic: No
314- :Option:
315-
316- Error count.
317+ :Option:
318+
319+ This variable contains a count of the number of errors from the previous
320+ statement executed in the current session. It is reset with each query,
321+ which includes any `SHOW VARIABLES` query, so only a
322+ `SELECT @@error_count` will get the previous warning count.
323+
324+ Similar to the :ref:`error_count <drizzled_warning_count>` variable, but
325+ for errors.
326
327 .. _drizzled_foreign_key_checks:
328
329@@ -665,7 +670,7 @@
330
331 :Scope: Global
332 :Dynamic: No
333- :Option:
334+ :Option:
335
336 If foreign key checks are enabled.
337
338@@ -683,7 +688,7 @@
339
340 :Scope: Global
341 :Dynamic: No
342- :Option:
343+ :Option:
344
345 Hostname of the server.
346
347@@ -693,7 +698,7 @@
348
349 :Scope: Global
350 :Dynamic: No
351- :Option:
352+ :Option:
353
354 Unknown.
355
356@@ -711,7 +716,7 @@
357
358 :Scope: Global
359 :Dynamic: No
360- :Option:
361+ :Option:
362
363 Last auto-increment insert ID value.
364
365@@ -721,7 +726,7 @@
366
367 :Scope: Global
368 :Dynamic: No
369- :Option:
370+ :Option:
371
372 Unknown.
373
374@@ -845,7 +850,7 @@
375
376 :Scope: Global
377 :Dynamic: No
378- :Option:
379+ :Option:
380
381 Unknown.
382
383@@ -927,7 +932,7 @@
384
385 :Scope: Global
386 :Dynamic: No
387- :Option:
388+ :Option:
389
390 Server UUID.
391
392@@ -945,7 +950,7 @@
393
394 :Scope: Global
395 :Dynamic: No
396- :Option:
397+ :Option:
398
399 Unknown.
400
401@@ -955,7 +960,7 @@
402
403 :Scope: Global
404 :Dynamic: No
405- :Option:
406+ :Option:
407
408 Unknown.
409
410@@ -965,7 +970,7 @@
411
412 :Scope: Global
413 :Dynamic: No
414- :Option:
415+ :Option:
416
417 Unknown.
418
419@@ -975,7 +980,7 @@
420
421 :Scope: Global
422 :Dynamic: No
423- :Option:
424+ :Option:
425
426 Unknown.
427
428@@ -985,7 +990,7 @@
429
430 :Scope: Global
431 :Dynamic: No
432- :Option:
433+ :Option:
434
435 Unknown.
436
437@@ -1043,7 +1048,7 @@
438
439 :Scope: Global
440 :Dynamic: No
441- :Option:
442+ :Option:
443
444 Current UNIX timestamp.
445
446@@ -1076,7 +1081,7 @@
447 * ``tx_isolation``
448
449 :Scope: Global
450- :Dynamic: No
451+ :Dynamic: No
452 :Option: :option:`--transaction-isolation`
453
454 .. _drizzled_unique_checks:
455@@ -1085,7 +1090,7 @@
456
457 :Scope: Global
458 :Dynamic: No
459- :Option:
460+ :Option:
461
462 Check UNIQUE indexes for uniqueness.
463
464@@ -1095,7 +1100,7 @@
465
466 :Scope: Global
467 :Dynamic: No
468- :Option:
469+ :Option:
470
471 Version control (Bazaar) branch.
472
473@@ -1105,7 +1110,7 @@
474
475 :Scope: Global
476 :Dynamic: No
477- :Option:
478+ :Option:
479
480 Version control (Bazaar) release id.
481
482@@ -1115,7 +1120,7 @@
483
484 :Scope: Global
485 :Dynamic: No
486- :Option:
487+ :Option:
488
489 Version control (Bazaar) revision id.
490
491@@ -1125,7 +1130,7 @@
492
493 :Scope: Global
494 :Dynamic: No
495- :Option:
496+ :Option:
497
498 Version control (Bazaar) revision number.
499
500@@ -1145,7 +1150,7 @@
501
502 :Scope: Global
503 :Dynamic: No
504- :Option:
505+ :Option:
506
507 Version comment.
508
509@@ -1155,7 +1160,7 @@
510
511 :Scope: Global
512 :Dynamic: No
513- :Option:
514+ :Option:
515
516 Version compile for machine type.
517
518@@ -1165,7 +1170,7 @@
519
520 :Scope: Global
521 :Dynamic: No
522- :Option:
523+ :Option:
524
525 Version compile for OS.
526
527@@ -1175,7 +1180,7 @@
528
529 :Scope: Global
530 :Dynamic: No
531- :Option:
532+ :Option:
533
534 Version compile for OS vendor.
535
536@@ -1183,8 +1188,14 @@
537
538 * ``warning_count``
539
540- :Scope: Global
541+ :Scope: Session
542 :Dynamic: No
543- :Option:
544-
545- Unknown.
546+ :Option:
547+
548+ This variable contains a count of the number of warnings from the previous
549+ statement executed in the current session. It is reset with each query,
550+ which includes any `SHOW VARIABLES` query, so only a
551+ `SELECT @@warning_count` will get the previous warning count.
552+
553+ Similar to the :ref:`error_count <drizzled_error_count>` variable, but
554+ for warnings.
555
556=== modified file 'drizzled/drizzled.cc'
557--- drizzled/drizzled.cc 2013-02-28 16:45:31 +0000
558+++ drizzled/drizzled.cc 2013-02-28 22:22:28 +0000
559@@ -1187,8 +1187,6 @@
560 _("Path to the database root."))
561 ("default-storage-engine", po::value<string>(),
562 _("Set the default storage engine for tables."))
563- ("default-time-zone", po::value<string>(),
564- _("Set the default time zone."))
565 ("exit-info,T", po::value<long>(),
566 _("Used for debugging; Use at your own risk!"))
567 ("gdb", po::value<bool>(&opt_debugging)->default_value(false)->zero_tokens(),

Subscribers

People subscribed via source and target branches

to all changes: