Merge lp:~fallenpegasus/drizzle/docu into lp:drizzle/7.0
- docu
- Merge into 7.0
Proposed by
Mark Atwood
Status: | Merged |
---|---|
Approved by: | Brian Aker |
Approved revision: | 2223 |
Merged at revision: | 2228 |
Proposed branch: | lp:~fallenpegasus/drizzle/docu |
Merge into: | lp:drizzle/7.0 |
Diff against target: |
696 lines (+173/-101) 22 files modified
docs/alter_schema.rst (+5/-2) docs/analyze.rst (+10/-4) docs/authentication.rst (+5/-2) docs/barriers.rst (+21/-7) docs/brief_history_of_drizzle.rst (+30/-9) docs/clients/drizzle.rst (+1/-1) docs/clients/drizzleadmin.rst (+1/-1) docs/clients/drizzledump.rst (+8/-6) docs/commit.rst (+11/-2) docs/configuration.rst (+4/-3) docs/contributing/code.rst (+19/-11) docs/contributing/documentation.rst (+8/-5) docs/contributing/introduction.rst (+9/-8) docs/create_index.rst (+3/-1) docs/create_table.rst (+2/-1) docs/data_dictionary.rst (+6/-2) docs/index.rst (+4/-4) docs/installing/from_source.rst (+4/-4) docs/installing/redhat.rst (+10/-16) docs/installing/requirements.rst (+5/-6) docs/installing/ubuntu.rst (+5/-4) docs/preface.rst (+2/-2) |
To merge this branch: | bzr merge lp:~fallenpegasus/drizzle/docu |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Drizzle Developers | Pending | ||
Review via email: mp+52508@code.launchpad.net |
Commit message
Description of the change
Content, phrasing, grammer, and copyediting fixes to documentation
To post a comment you must log in.
Revision history for this message
Andrew Hutchings (linuxjedi) wrote : | # |
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'docs/alter_schema.rst' |
2 | --- docs/alter_schema.rst 2011-02-15 22:03:42 +0000 |
3 | +++ docs/alter_schema.rst 2011-03-08 03:54:54 +0000 |
4 | @@ -3,7 +3,10 @@ |
5 | |
6 | ALTER SCHEMA changes the definition of a schema. |
7 | |
8 | -You must own the schema to use ALTER SCHEMA. To rename a schema you must also have the CREATE privilege for the database. To alter the owner, you must also be a direct or indirect member of the new owning role, and you must have the CREATE privilege for the database: |
9 | +You must own the schema to use ALTER SCHEMA. To rename a schema you |
10 | +must also have the CREATE privilege for the database. To alter the |
11 | +owner, you must also be a direct or indirect member of the new owning |
12 | +role, and you must have the CREATE privilege for the database: |
13 | |
14 | .. code-block:: mysql |
15 | |
16 | @@ -16,7 +19,7 @@ |
17 | |
18 | new_name |
19 | |
20 | - The new name of the schema. The new name cannot begin with "pg", as such names are reserved for system schemas. |
21 | + The new name of the schema. |
22 | |
23 | new_owner |
24 | |
25 | |
26 | === modified file 'docs/analyze.rst' |
27 | --- docs/analyze.rst 2011-02-23 13:08:09 +0000 |
28 | +++ docs/analyze.rst 2011-03-08 03:54:54 +0000 |
29 | @@ -7,11 +7,17 @@ |
30 | |
31 | ANALYZE TABLE table_name [, table_name] ... |
32 | |
33 | -ANALYZE TABLE usually read locks a table, and then analyzes and stores the key distribution for a table. |
34 | +ANALYZE TABLE usually read locks a table, and then analyzes and stores |
35 | +the key distribution for a table. |
36 | |
37 | ANALYZE functionality differs depending on the storage engine. |
38 | |
39 | -On InnoDB tables, using ANALYZE will result in a WRITE LOCK on the table. It also will not perform an explicit gathering of statistics when |
40 | -you issue an ANALYZE command. To update the index cardinality, there will be 10 random dives into each index, retrieving an estimated cardinality. Therefore, several ANALYZE TABLEs in a row are likely to produce different results each time. |
41 | +On InnoDB tables, using ANALYZE will result in a WRITE LOCK on the |
42 | +table. It also will not perform an explicit gathering of statistics |
43 | +when you issue an ANALYZE command. To update the index cardinality, |
44 | +there will be 10 random dives into each index, retrieving an estimated |
45 | +cardinality. Therefore, several ANALYZE TABLEs in a row are likely to |
46 | +produce different results each time. |
47 | |
48 | -Statistics-gathering with ANALYZE has recently been added to HailDB so that index dives are performed. |
49 | +Statistics-gathering with ANALYZE has recently been added to HailDB so |
50 | +that index dives are performed. |
51 | |
52 | === modified file 'docs/authentication.rst' |
53 | --- docs/authentication.rst 2011-02-21 19:30:48 +0000 |
54 | +++ docs/authentication.rst 2011-03-08 03:54:54 +0000 |
55 | @@ -3,7 +3,10 @@ |
56 | |
57 | For Drizzle, authentication is handled by plugins. |
58 | |
59 | -Authentication is no longer based on the host/user and schema/table/column model that was used in the MyISAM-based mysql.user table. |
60 | +Authentication is no longer based on the host/user and |
61 | +schema/table/column model that was used in the MyISAM-based mysql.user |
62 | +table. |
63 | |
64 | -The pluggable model capitalizes on existing systems such as PAM, LDAP via PAM and Http authentication. |
65 | +The pluggable model capitalizes on existing systems such as PAM, LDAP |
66 | +via PAM and HTTP authentication. |
67 | |
68 | |
69 | === modified file 'docs/barriers.rst' |
70 | --- docs/barriers.rst 2011-02-23 14:17:23 +0000 |
71 | +++ docs/barriers.rst 2011-03-08 03:54:54 +0000 |
72 | @@ -13,17 +13,31 @@ |
73 | |
74 | SELECT signal(); |
75 | |
76 | -A barrier is a synchronization object which can be used to synchronize a group of sessions to a specific rendezvous by calling wait(). When wait() is called, any session of the user may call signal(), allowing all sessions being held by wait() to proceed. |
77 | - |
78 | -Barriers can optionally be created with a limit so that once a set number of sessions have called wait() that all "waiters" are then allowed to proceed. |
79 | - |
80 | -The session that creates the barrier via create_barrier() is not allowed to call either wait() or wait_until(). |
81 | +A barrier is a synchronization object which can be used to synchronize |
82 | +a group of sessions to a specific rendezvous by calling wait(). When |
83 | +wait() is called, any session of the user may call signal(), allowing |
84 | +all sessions being held by wait() to proceed. |
85 | + |
86 | +Barriers can optionally be created with a limit so that once a set |
87 | +number of sessions have called wait() that all "waiters" are then |
88 | +allowed to proceed. |
89 | + |
90 | +The session that creates the barrier via create_barrier() is not |
91 | +allowed to call either wait() or wait_until(). |
92 | |
93 | The scope of barriers is to the given username. |
94 | |
95 | -Beyond waiters, you can also create observers by using the wait_until() function. Observers are released not only when signal() or release_barrier() is called, but also when their definitive predicate happens. You can use wait_until() to have a session wait for a certain number of waiters to occur, and then do some body of work before the waiters() are signaled to continue. |
96 | +Beyond waiters, you can also create observers by using the |
97 | +wait_until() function. Observers are released not only when signal() |
98 | +or release_barrier() is called, but also when their definitive |
99 | +predicate happens. You can use wait_until() to have a session wait for |
100 | +a certain number of waiters to occur, and then do some body of work |
101 | +before the waiters() are signaled to continue. |
102 | |
103 | -All waiters and observers are released if release_barrier() is called by the session which created the barrier. Also, if the session that created the barrier disconnects, all waiters and observers are notified. |
104 | +All waiters and observers are released if release_barrier() is called |
105 | +by the session which created the barrier. Also, if the session that |
106 | +created the barrier disconnects, all waiters and observers are |
107 | +notified. |
108 | |
109 | Information on all barriers can be found in the DATA_DICTIONARY.USER_BARRIERS table. |
110 | |
111 | |
112 | === modified file 'docs/brief_history_of_drizzle.rst' |
113 | --- docs/brief_history_of_drizzle.rst 2011-02-13 20:50:37 +0000 |
114 | +++ docs/brief_history_of_drizzle.rst 2011-03-08 03:54:54 +0000 |
115 | @@ -4,12 +4,33 @@ |
116 | |
117 | Drizzle came into being for both social and technical reasons. |
118 | |
119 | -The Drizzle project began in 2008 when Brian Aker forked it from MySQL, following Sun Microsystems' acquisition of MySQL. The Drizzle project was announced in 2008 at the O'Reilly Open Source Conference. |
120 | - |
121 | -In terms of technical goals, Drizzle is based on a micro-kernel design that aims to be as pluggable as possible. Anyone should be able to quickly extend the database for their database needs. Drizzle has been designed for modern architectures and deployments. Drizzle does not shy away from breaking with the past, many of the MySQL "Gotchas" (features that work as advertised but not necessarily as expected) have been removed. |
122 | - |
123 | -Drizzle is open source software, designed in an organic manner by developers that span different companies. The development process has been geared to be more similar to the Linux Kernel where no single company owns the source code, or provides all of the developers. In stark difference to MySQL, the goal is to be as inclusive as possible and provide stable releases. The social charter of Drizzle encourages diversity and prizes respectful dialogue between all participating parties. |
124 | - |
125 | -Drizzle today is the largest fork of the MySQL server. At the time of writing, core developers span five companies, with as many, and sometimes more then, 30+ developers participating each month. Drizzle provides releases every other week and is the most well-tested database in the MySQL family tree. |
126 | - |
127 | -More narrative on the project can be found on `Wikipedia <http://en.wikipedia.org/wiki/Drizzle_(database_server)>`_ |
128 | +The Drizzle project began in 2008 when Brian Aker forked it from |
129 | +MySQL, following Sun Microsystems' acquisition of MySQL. The Drizzle |
130 | +project was announced in 2008 at the O'Reilly OSCOn Open Source |
131 | +Conference. |
132 | + |
133 | +In terms of technical goals, Drizzle is based on a micro-kernel design |
134 | +that aims to be as pluggable as possible. Anyone should be able to |
135 | +quickly extend the database for their database needs. Drizzle has been |
136 | +designed for modern architectures and deployments. Drizzle does not |
137 | +shy away from breaking with the past, many of the MySQL "Gotchas" |
138 | +(features that work as advertised but not necessarily as expected) |
139 | +have been removed. |
140 | + |
141 | +Drizzle is open source software, designed in an organic manner by |
142 | +developers that span different companies. The development process has |
143 | +been geared to be more similar to the Linux Kernel where no single |
144 | +company owns the source code, or provides all of the developers. In |
145 | +stark difference to MySQL, the goal is to be as inclusive as possible |
146 | +and provide stable releases. The social charter of Drizzle encourages |
147 | +diversity and prizes respectful dialogue between all participating |
148 | +parties. |
149 | + |
150 | +Drizzle today is the most active fork of the MySQL server. At the time |
151 | +of writing, core developers span five companies, with as many, and |
152 | +sometimes more then, 30+ developers participating each month. Drizzle |
153 | +provides releases every other week and is the most well-tested |
154 | +database in the MySQL family tree. |
155 | + |
156 | +More narrative on the project can be found on |
157 | +`Wikipedia <http://en.wikipedia.org/wiki/Drizzle_(database_server)>`_ |
158 | |
159 | === modified file 'docs/clients/drizzle.rst' |
160 | --- docs/clients/drizzle.rst 2010-09-26 21:24:38 +0000 |
161 | +++ docs/clients/drizzle.rst 2011-03-08 03:54:54 +0000 |
162 | @@ -1,5 +1,5 @@ |
163 | Drizzle Commandline Client |
164 | ========================== |
165 | |
166 | -The :program:`drizzle` command line client is the primary program for |
167 | +The :program:`drizzle` command line client is the primary program for ad-hoc |
168 | connecting to and manipulating a Drizzle database. |
169 | |
170 | === modified file 'docs/clients/drizzleadmin.rst' |
171 | --- docs/clients/drizzleadmin.rst 2011-02-23 15:33:37 +0000 |
172 | +++ docs/clients/drizzleadmin.rst 2011-03-08 03:54:54 +0000 |
173 | @@ -2,7 +2,7 @@ |
174 | ================================ |
175 | |
176 | The :program:`drizzleadmin` command line client is the primary program for |
177 | -connecting to and manipulating a Drizzle database with an administrative user. |
178 | +connecting to and manipulating a Drizzle database with an administrative user rights. |
179 | |
180 | The :program:`drizzleadmin` tool can only connect using the 'root' user and |
181 | only on IP addresses defined by drizzle-protocol.admin-ip-addresses or |
182 | |
183 | === modified file 'docs/clients/drizzledump.rst' |
184 | --- docs/clients/drizzledump.rst 2011-02-24 09:41:17 +0000 |
185 | +++ docs/clients/drizzledump.rst 2011-03-08 03:54:54 +0000 |
186 | @@ -15,11 +15,11 @@ |
187 | |
188 | :program:`drizzledump` is used for backing up and |
189 | restoring logical backups of a Drizzle database, as well as for migrating |
190 | -from *MySQL*. |
191 | +from a more traditional *MySQL* server. |
192 | |
193 | -When connecting to a Drizzle server it will do a plain dump of the server. It |
194 | -will, however, automatically detect when it is connected to a *MySQL* server and |
195 | -will convert the tables and data into a Drizzle compatible format. |
196 | +When connecting to a Drizzle server it will do a plain dump of the server. |
197 | +When connecting to a MySQL server, it will automatically detect this, and |
198 | +will convert the dump of the tables and data into a Drizzle compatible format. |
199 | |
200 | Any binary data in tables will be converted into hexadecimal output so that it |
201 | does not corrupt the dump file. |
202 | @@ -41,7 +41,7 @@ |
203 | |
204 | .. option:: --force, -f |
205 | |
206 | - Continue even if we get an sql-error. |
207 | + Continue even if a sql-error is received. |
208 | |
209 | .. option:: --help, -? |
210 | |
211 | @@ -96,6 +96,8 @@ |
212 | INSERT INTO `t1` VALUES (1,'hello'); |
213 | INSERT INTO `t1` VALUES (2,'world'); |
214 | |
215 | + This is useful for calculating and storing diffs of dump files. |
216 | + |
217 | .. option:: --skip-dump-date |
218 | |
219 | Do not display the date/time at the end of the dump. |
220 | @@ -149,7 +151,7 @@ |
221 | |
222 | .. option:: --no-data, -d |
223 | |
224 | - Do not dump the data itself, used to dump the schemas only. |
225 | + Do not dump the data itself. Used to dump the schemas only. |
226 | |
227 | .. option:: --replace |
228 | |
229 | |
230 | === modified file 'docs/commit.rst' |
231 | --- docs/commit.rst 2011-02-23 13:08:09 +0000 |
232 | +++ docs/commit.rst 2011-03-08 03:54:54 +0000 |
233 | @@ -5,9 +5,18 @@ |
234 | |
235 | Calling COMMIT will cause the current transaction to save itself. |
236 | |
237 | -A COMMIT statement ends a transaction within Drizzle and makes all changes visible to other users. The order of events is typically to issue a START TRANSACTION statement, execute one or more SQL statements, and then issue a COMMIT statement. Alternatively, a ROLLBACK statement can be issued, which undoes all the work performed since START TRANSACTION was issued. A COMMIT statement will also release any existing savepoints that may be in use. |
238 | +A COMMIT statement ends a transaction within Drizzle and makes all |
239 | +changes visible to other users. The order of events is typically to |
240 | +issue a START TRANSACTION statement, execute one or more SQL |
241 | +statements, and then issue a COMMIT statement. Alternatively, a |
242 | +ROLLBACK statement can be issued, which undoes all the work performed |
243 | +since START TRANSACTION was issued. A COMMIT statement will also |
244 | +release any existing savepoints that may be in use. |
245 | |
246 | -For example, DML statements do not implicitly commit the current transaction. If a user's DML statements have been used to update some data objects, and the updates need to be permanently recorded in the database, you can use the COMMIT command. |
247 | +For example, DML statements do not implicitly commit the current |
248 | +transaction. If a user's DML statements have been used to update some |
249 | +data objects, and the updates need to be permanently recorded in the |
250 | +database, you can use the COMMIT command. |
251 | |
252 | An example: |
253 | |
254 | |
255 | === modified file 'docs/configuration.rst' |
256 | --- docs/configuration.rst 2011-02-23 14:17:23 +0000 |
257 | +++ docs/configuration.rst 2011-03-08 03:54:54 +0000 |
258 | @@ -7,9 +7,9 @@ |
259 | -------- |
260 | |
261 | Drizzle can draw its configuration from a number of sources, including the |
262 | -command line, configuration files and environment variables. |
263 | +command line, from configuration files, and from environment variables. |
264 | |
265 | -Support is planned for pluggable configuration souces. |
266 | +Support is planned for pluggable configuration sources. |
267 | |
268 | ---------------- |
269 | Loading Sequence |
270 | @@ -38,7 +38,8 @@ |
271 | *DRIZZLED_INNODB_BUFFER_POOL_SIZE* |
272 | |
273 | The config files contain a set of lines of the form `option-name=value`, one |
274 | -per line. Due to a bug in Boost.Program_options Boolean values require an argument, e.g. `console.enable=true`. |
275 | +per line. Due to a bug in Boost.Program_options Boolean values require an argument, |
276 | +e.g. `console.enable=true`. |
277 | |
278 | Config files support section headers such as `[innodb]` with all options |
279 | occuring subsequently being prefixed by the section header. For instance, if |
280 | |
281 | === modified file 'docs/contributing/code.rst' |
282 | --- docs/contributing/code.rst 2011-02-24 14:52:15 +0000 |
283 | +++ docs/contributing/code.rst 2011-03-08 03:54:54 +0000 |
284 | @@ -14,10 +14,18 @@ |
285 | #. Paste your public key into the text box and click the *Import public key* |
286 | button |
287 | |
288 | +Logging into Launchpad |
289 | +---------------------- |
290 | + |
291 | +You will need to set up your local bzr configuration with your Launchpad account |
292 | +so that you can push branches for merging. To do this: |
293 | + |
294 | + # bzr launchpad-login username |
295 | + |
296 | Getting the Code |
297 | ---------------- |
298 | |
299 | -You will need to prepare a directory for working with Drizzle, the following |
300 | +You will need to prepare a directory for working with Drizzle. The following |
301 | example will assume you want to do this in ~/repos/drizzle: |
302 | |
303 | .. code-block:: bash |
304 | @@ -26,9 +34,9 @@ |
305 | cd ~/repos |
306 | bzr init-repo drizzle |
307 | |
308 | -At this stage you now have an initialized a directory for bzr to use. Revision |
309 | -data will be stored here to save it having to be downloaded/stored for every |
310 | -branch. |
311 | +At this stage you now have an initialized a directory named ~/repos/drizzle |
312 | +for bzr to use. Revision data will be stored in this directory so that it |
313 | +does not have to be separately downloaded and stored for every branch. |
314 | |
315 | .. code-block:: bash |
316 | |
317 | @@ -49,7 +57,7 @@ |
318 | --------------- |
319 | |
320 | All commits need to have a proper description of the changes made. This is so |
321 | -that future developers can dig through the bzr log to find out why a certain |
322 | +that future developers can read through the bzr log to find out why a certain |
323 | change happened. |
324 | |
325 | When committing a bug fix please use: |
326 | @@ -64,13 +72,13 @@ |
327 | Coding Standards |
328 | ---------------- |
329 | |
330 | -Our coding standards can be found inside the |
331 | +Our coding standards can be found at the |
332 | `Drizzle wiki <http://wiki.drizzle.org/Coding_Standards>`_. |
333 | |
334 | Test Cases |
335 | ---------- |
336 | |
337 | -Where possible SQL test cases should be created for your code. Our test cases |
338 | +Where possible, SQL test cases should be created for your code. Our test cases |
339 | for bug fixes should be in the ``tests/suite/regression`` directory. For more |
340 | information about creating test cases please see the :ref:`test run <test-run-label>` |
341 | section of our documentation. |
342 | @@ -93,11 +101,11 @@ |
343 | --------------- |
344 | |
345 | Once your work is done and ready for review you can go to the |
346 | -`code page <https://code.launchpad.net/drizzle>`_, click on your branch and you |
347 | -will see a link saying *Propose for merging*. |
348 | +`code page <https://code.launchpad.net/drizzle>`_, and then click on your branch. |
349 | +You will see a link labeled *Propose for merging*. |
350 | |
351 | In this screen simply fill in what this branch does and click the |
352 | *Propose Merge* button. Someone will review the branch, usually within a day or |
353 | -two and if approved it will go though our rigourous testing process which can |
354 | -take several hours. If it needs more work feedback will always be given to |
355 | +two. If approved, it will go though our rigourous testing process, which can |
356 | +take several hours. If it needs more work, feedback will always be given to |
357 | explain why. |
358 | |
359 | === modified file 'docs/contributing/documentation.rst' |
360 | --- docs/contributing/documentation.rst 2011-02-24 14:52:15 +0000 |
361 | +++ docs/contributing/documentation.rst 2011-03-08 03:54:54 +0000 |
362 | @@ -3,10 +3,13 @@ |
363 | Contributing Documentation |
364 | ========================== |
365 | |
366 | -Our documentation is written using `Sphinx Documentation Generator <http://sphinx.pocoo.org/>`_ which uses the `reStructuredText <http://docutils.sf.net/rst.html>`_ format. |
367 | +Our documentation is written using |
368 | +`Sphinx Documentation Generator <http://sphinx.pocoo.org/>`_ |
369 | +which uses the `reStructuredText <http://docutils.sf.net/rst.html>`_ format. |
370 | |
371 | -All our documentation is stored in the main source reporistory in the docs/ |
372 | -directory, and every merge into trunk triggers a rebuild of our `documentation site <http://docs.drizzle.org/>`_. |
373 | +All our documentation is stored in the main source reposatory in the docs/ |
374 | +directory, and every merge into trunk triggers a rebuild of our |
375 | +`documentation site <http://docs.drizzle.org/>`_. |
376 | |
377 | Requirements |
378 | ------------ |
379 | @@ -15,7 +18,7 @@ |
380 | all of it will build correctly in that version. For correct documentation |
381 | version 1.0 is required. |
382 | |
383 | -When building the documentation warnings become errors, so the documentation |
384 | +When building the documentation warnings are treated as errors, so the documentation |
385 | needs to be warning free in 1.0. |
386 | |
387 | Documentation Files |
388 | @@ -41,7 +44,7 @@ |
389 | -------------------- |
390 | |
391 | The documentation is in the reStructured text format which is a wiki-like markup |
392 | -laungauge ideal for documentation. |
393 | +language ideal for documentation. |
394 | |
395 | Headings |
396 | ^^^^^^^^ |
397 | |
398 | === modified file 'docs/contributing/introduction.rst' |
399 | --- docs/contributing/introduction.rst 2011-02-24 14:57:37 +0000 |
400 | +++ docs/contributing/introduction.rst 2011-03-08 03:54:54 +0000 |
401 | @@ -2,38 +2,39 @@ |
402 | ============ |
403 | |
404 | Drizzle's development primarily happens on |
405 | -`Launchpad <http://launchpad.net/drizzle>`_ which handles code hosting, bugs, |
406 | +`Launchpad <https://launchpad.net/drizzle>`_ which handles code hosting, bugs tracking, |
407 | mailing lists and everything else needed for project management. You will need |
408 | a `Launchpad account <https://help.launchpad.net/YourAccount/NewAccount>`_ |
409 | before making most kinds of contributions. |
410 | |
411 | One of Drizzle's aims is to have community contributions valued in the same way |
412 | -as core developer contributions, and all code goes through exactly the same |
413 | +as core developer contributions, and to have all code undergo exactly the same |
414 | approval and testing process no matter who it comes from (core developers or |
415 | general community). |
416 | |
417 | -There are many ways to contribute to Drizzle, for example: |
418 | +There are many ways to contribute to Drizzle. For example, you can: |
419 | |
420 | * `File a bug <https://bugs.launchpad.net/drizzle/+filebug>`_ |
421 | * `Write translations <https://translations.launchpad.net/drizzle>`_ |
422 | * :ref:`Write documentation <documentation-label>` |
423 | * :ref:`Write code <code-label>` |
424 | |
425 | -We recommend anyone new to Drizzle who wants to learn the code see the `Low |
426 | -hanging fruit <https://bugs.launchpad.net/drizzle/+bugs?field.tag=low-hanging-fruit>`_ list of bugs on Launchpad for possible tasks to take on. |
427 | +We recommend anyone new to Drizzle who wants to learn the code see the |
428 | +`Low hanging fruit <https://bugs.launchpad.net/drizzle/+bugs?field.tag=low-hanging-fruit>`_ |
429 | +list of bugs on Launchpad for possible tasks to take on. |
430 | |
431 | Bazaar |
432 | ------ |
433 | |
434 | Launchpad uses `Bazaar <https://launchpad.net/bazaar>`_ for revision control of |
435 | -the source repositories, you will need this insalled before contributing |
436 | +the source repositories and for documentation. You will need this installed before contributing |
437 | documentation or code. |
438 | |
439 | Finding Help |
440 | ------------ |
441 | |
442 | -If you have any questions please contact us at |
443 | +If you have any questions please contact us at the |
444 | `#drizzle <irc://irc.freenode.net/drizzle>`_ |
445 | -`Freenode <http://freenode.net/>`_ IRC channel or via. the |
446 | +`Freenode <http://freenode.net/>`_ IRC channel or on the |
447 | `Drizzle Discuss <https://launchpad.net/~drizzle-discuss>`_ mailing list. |
448 | |
449 | |
450 | === modified file 'docs/create_index.rst' |
451 | --- docs/create_index.rst 2011-02-23 14:17:23 +0000 |
452 | +++ docs/create_index.rst 2011-03-08 03:54:54 +0000 |
453 | @@ -14,4 +14,6 @@ |
454 | This would create an index on table_t named table_1_index that converged |
455 | columns a and b. |
456 | |
457 | -Fast index creation (where a storage engine can create or drop indexes without copying and rebuilding the contents of the entire table) is not implemented yet for Drizzle, but it is slated for the future. |
458 | +Fast index creation (where a storage engine can create or drop indexes |
459 | +without copying and rebuilding the contents of the entire table) is |
460 | +not implemented yet for Drizzle, but it is slated for the future. |
461 | |
462 | === modified file 'docs/create_table.rst' |
463 | --- docs/create_table.rst 2011-02-23 14:17:23 +0000 |
464 | +++ docs/create_table.rst 2011-03-08 03:54:54 +0000 |
465 | @@ -1,7 +1,8 @@ |
466 | CREATE TABLE |
467 | ============ |
468 | |
469 | -A CREATE statement in SQL creates an object inside of Drizzle. One of the most common CREATE commands is the CREATE TABLE command. |
470 | +A CREATE statement in SQL creates an object inside of Drizzle. One of |
471 | +the most common CREATE commands is the CREATE TABLE command. |
472 | |
473 | .. code-block:: mysql |
474 | |
475 | |
476 | === modified file 'docs/data_dictionary.rst' |
477 | --- docs/data_dictionary.rst 2011-02-13 20:50:37 +0000 |
478 | +++ docs/data_dictionary.rst 2011-03-08 03:54:54 +0000 |
479 | @@ -1,13 +1,17 @@ |
480 | DATA_DICTIONARY |
481 | =============== |
482 | |
483 | -The DATA_DICTIONARY is a Drizzle extension that provides information on the state of the database, and on the definitions of tables and other objects. In other contexts this is what might be referred to as the system catalog. |
484 | +The DATA_DICTIONARY is a Drizzle extension that provides information |
485 | +on the state of the database, and on the definitions of tables and |
486 | +other objects. In other contexts this is what might be referred to as |
487 | +the system catalog. |
488 | |
489 | Plugins may add extra DATA_DICTIONARY tables with information specific to them. |
490 | |
491 | If you wish to write portable tools you should make use of the INFORMATION_SCHEMA. |
492 | |
493 | -That table contains the name and value of the :doc:`/variables` that the user has created during the current session. |
494 | +That table contains the name and value of the :doc:`/variables` that |
495 | +the user has created during the current session. |
496 | |
497 | .. todo:: |
498 | |
499 | |
500 | === modified file 'docs/index.rst' |
501 | --- docs/index.rst 2011-03-02 23:58:31 +0000 |
502 | +++ docs/index.rst 2011-03-08 03:54:54 +0000 |
503 | @@ -8,14 +8,14 @@ |
504 | |
505 | .. image:: logo.png |
506 | |
507 | -Drizzle is a transactional, relational, community-driven open source database that is forked from the popular MySQL database. |
508 | +Drizzle is a transactional, relational, community-driven open-source database that is forked from the popular MySQL database. |
509 | |
510 | -The Drizzle team has removed non-essential code, re-factored the remaining code and modernized the code base moving to C++. |
511 | +The Drizzle team has removed non-essential code, has re-factored the remaining code, and has converted the code to modern C++ and modern libraries. |
512 | |
513 | Charter |
514 | * A database optimized for Cloud infrastructure and Web applications |
515 | - * Design for massive concurrency on modern multi-cpu architecture |
516 | - * Optimize memory for increased performance and parallelism |
517 | + * Design for massive concurrency on modern multi-CPU architectures |
518 | + * Optimize memory use for increased performance and parallelism |
519 | * Open source, open community, open design |
520 | |
521 | Scope |
522 | |
523 | === modified file 'docs/installing/from_source.rst' |
524 | --- docs/installing/from_source.rst 2011-02-15 22:03:42 +0000 |
525 | +++ docs/installing/from_source.rst 2011-03-08 03:54:54 +0000 |
526 | @@ -6,7 +6,7 @@ |
527 | |
528 | Minimal Requirements |
529 | ^^^^^^^^^^^^^^^^^^^^ |
530 | -To compile Drizzle with the most basic set of pluginsyou will need to following |
531 | +To compile Drizzle with the most basic set of plugins, you will need to have the following |
532 | dependencies installed: |
533 | |
534 | * autoconf |
535 | @@ -35,7 +35,7 @@ |
536 | Full Dependencies |
537 | ^^^^^^^^^^^^^^^^^ |
538 | Additionally, if you wish to build all of the plugins, you will need to install |
539 | -these too: |
540 | +these additional dependencies: |
541 | |
542 | * libcurl4-gnutls-dev |
543 | * libgcrypt11-dev |
544 | @@ -53,7 +53,7 @@ |
545 | Obtaining The Source |
546 | -------------------- |
547 | The latest source release can always be found on our `LaunchPad site |
548 | -<https://launchpad.net/drizzle>`_, alternatively the bzr source from our stable |
549 | +<https://launchpad.net/drizzle>`_. Alternatively, the bzr source respositoryfrom our stable |
550 | trunk can be obtained by doing: |
551 | |
552 | .. code-block:: bash |
553 | @@ -62,7 +62,7 @@ |
554 | |
555 | Compiling The Source |
556 | -------------------- |
557 | -Compiling is as simple as doing the following inside the source: |
558 | +Compiling is done by performing the standard automake commands from the top level directory inside the source: |
559 | |
560 | .. code-block:: bash |
561 | |
562 | |
563 | === modified file 'docs/installing/redhat.rst' |
564 | --- docs/installing/redhat.rst 2011-03-03 00:16:22 +0000 |
565 | +++ docs/installing/redhat.rst 2011-03-08 03:54:54 +0000 |
566 | @@ -3,25 +3,19 @@ |
567 | |
568 | Using RPMs |
569 | ---------- |
570 | -We have a custom RedHat/Fedora repository at |
571 | +There is a custom RedHat/Fedora repository at |
572 | http://rpm.drizzle.org/7-dev/ which includes everything needed |
573 | -to install or compile Drizzle on RedHat 5 and 6 as well as Fedora 13 - 14. |
574 | - |
575 | -A pre-requisite of this repository in RedHat is that the |
576 | -`EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository is also added to your |
577 | -distribution. |
578 | - |
579 | -.. note:: |
580 | - |
581 | - The EPEL repository is not required in Fedora. |
582 | - |
583 | -To add that repository, run the following command: |
584 | +to install or compile Drizzle on RedHat/CentOS 5 and 6 as well as on Fedora 12 through 14. |
585 | + |
586 | +On Redhat/CentOS systems, but not on Fedora systems, you must add the |
587 | +`EPEL reposatory<http://fedoraproject.org/wiki/EPEL>`_ |
588 | +to your RPM configuration, by running the following command: |
589 | |
590 | .. code-block:: bash |
591 | |
592 | sudo rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-4.noarch.rpm |
593 | |
594 | -To add the repository to your distribution you also need to create a /etc/yum.repos.d/drizzle.repo file with the following content: |
595 | +To add the Drizzle repository to your system you also need to create a /etc/yum.repos.d/drizzle.repo file with the following content: |
596 | |
597 | *RedHat* |
598 | |
599 | @@ -55,15 +49,15 @@ |
600 | enabled=1 |
601 | gpgcheck=0 |
602 | |
603 | -You can then use the following shell command: |
604 | +You can then install Drizzle by running the following command: |
605 | |
606 | .. code-block:: bash |
607 | |
608 | - yum install drizzle7-server drizzle7-client |
609 | + sudo yum install drizzle7-server drizzle7-client |
610 | |
611 | Compiling From Source |
612 | --------------------- |
613 | -To compile from source you will need to add the repositories above and then install the following packages: |
614 | +To compile from source you will need to add the repositories described above, and then install the following packages: |
615 | |
616 | * bzr |
617 | * boost-devel |
618 | |
619 | === modified file 'docs/installing/requirements.rst' |
620 | --- docs/installing/requirements.rst 2011-01-30 01:40:02 +0000 |
621 | +++ docs/installing/requirements.rst 2011-03-08 03:54:54 +0000 |
622 | @@ -5,18 +5,18 @@ |
623 | ------------------- |
624 | When installing Drizzle we typically recommend either using the packages from |
625 | a Linux distribution or packages provided by our own repositories. This is |
626 | -down to the dependencies reqiured by Drizzle which can be too old or missing |
627 | +because the dependencies required by Drizzle can sometimes be too old or missing |
628 | in some Linux distributions. |
629 | |
630 | Every build of Drizzle is currently tested on: |
631 | - * Fedora 12 - 14 |
632 | + * Fedora 12 through 14 |
633 | * RedHat (or CentOS) 5 and 6 |
634 | * Debian Squeeze (6.0) |
635 | * Ubuntu 10.04 and 10.10 |
636 | * FreeBSD 8.0 and 8.1 |
637 | * Apple OSX 10.6.4 |
638 | |
639 | -We recommend using these platforms with Drizzle, older version may have various |
640 | +We recommend using these platforms with Drizzle. Older platforms may have various |
641 | unforseen difficulties when compiling and/or installing. Drizzle is tested on |
642 | both 32bit and 64bit platforms but we recommend using a 64bit platform. |
643 | |
644 | @@ -26,8 +26,7 @@ |
645 | |
646 | * `Boost <http://www.boost.org/>`_ 1.40 or higher |
647 | * `Google Protocol Buffers <http://code.google.com/apis/protocolbuffers/>`_ |
648 | - * libuuid (part of the `E2fsprogs <http://e2fsprogs.sourceforge.net/>`_ |
649 | - project) |
650 | + * libuuid (part of the `E2fsprogs <http://e2fsprogs.sourceforge.net/>`_ project) |
651 | * `zlib <http://www.zlib.net/>`_ 1.1.3-5 or higher |
652 | |
653 | -Our repositories for RedHat/Fedora and Ubuntu will provide these where required. |
654 | +Our repositories for RedHat/CentOS/Fedora and for Ubuntu will provide these where required. |
655 | |
656 | === modified file 'docs/installing/ubuntu.rst' |
657 | --- docs/installing/ubuntu.rst 2011-02-23 15:33:37 +0000 |
658 | +++ docs/installing/ubuntu.rst 2011-03-08 03:54:54 +0000 |
659 | @@ -4,18 +4,19 @@ |
660 | Using DEBs |
661 | ---------- |
662 | |
663 | -Ubuntu Natty (11.04) has Drizzle .deb files in the repositories. For Ubuntu 10.04 and 10.10 we have a PPA available at |
664 | +Ubuntu 11.04 Natty Narwhal has Drizzle .deb files in the standard Ubuntu repositories. |
665 | +For Ubuntu 10.04 LTS Lucid Lynx and Ubuntu 10.10 Maverick Meerkat there is a PPA available at |
666 | https://launchpad.net/~drizzle-developers/+archive/ppa |
667 | |
668 | As a first step, run the following command: :: |
669 | |
670 | sudo apt-get install python-software-properties |
671 | |
672 | -To add the above PPA at command line simply run: :: |
673 | +To add the above PPA at command line: :: |
674 | |
675 | sudo apt-add-repository ppa:drizzle-developers/ppa |
676 | sudo apt-get update |
677 | |
678 | -To then install Drizzle: :: |
679 | +Then to install Drizzle, both the server and the client utilities: :: |
680 | |
681 | - sudo apt-get install drizzle drizzle-client |
682 | + sudo apt-get install drizzle |
683 | |
684 | === modified file 'docs/preface.rst' |
685 | --- docs/preface.rst 2010-11-30 00:28:02 +0000 |
686 | +++ docs/preface.rst 2011-03-08 03:54:54 +0000 |
687 | @@ -2,6 +2,6 @@ |
688 | Preface |
689 | ================ |
690 | |
691 | -Welcome to Drizzle's official documentation. This community-generated resource covers what Drizzle is, the basics of the SQL language, and other advanced topics for Drizzle users. It has been written by the Drizzle developers and other volunteers in parallel to the development of the Drizzle software. In essence, it describes all the functionality that the current version of Drizzle officially supports. |
692 | +Welcome to Drizzle's official documentation. This community-generated resource covers what Drizzle is, the SQL language as implemented by Drizzle, and other basic and advanced topics. It has been written by the Drizzle developers and other volunteers in parallel to the development of the Drizzle software. It describes all the functionality that the current version of Drizzle officially supports. |
693 | |
694 | -There are other sites and locations for information on Drizzle and contributing to the project. You can find code, bug reports, and downloads at http://launchpad.net/drizzle. The wiki for Drizzle can be found at http://wiki.drizzle.org/Main_Page. |
695 | \ No newline at end of file |
696 | +There are other sites and locations for information on Drizzle and contributing to the project. You can find code, bug reports, and downloads at `Launchpad <https://launchpad.net/drizzle>`_. The wiki for Drizzle can be found at http://wiki.drizzle.org/Main_Page. |
Excellent work. Just one comment:
+so that you can push branches for merging. To do this:
+
+ # bzr launchpad-login username
+
This should probably use "..code-block: bash" or at east :: and indentation.