From: Date: March 23 2004 4:05pm Subject: bk commit - mysqldoc tree (Administrator:1.1333) List-Archive: http://lists.mysql.com/internals/13072 Message-Id: <200403231505.i2NF5LHW005299@mail.mysql.com> Below is the list of changes that have just been committed into a local mysqldoc repository of Administrator. When Administrator does a push these changes will be propagated to the main repository and, within 24 hours after the push, to the public repository. For information on how to access the public repository see http://www.mysql.com/doc/I/n/Installing_source_tree.html ChangeSet 1.1333 04/03/23 16:05:17 Administrator@athena. +2 -0 slartibartfast.xml: Completed contributor tools section Prepared other toolset sectionsrest of toolset sections html.css: new file Docs/slartibartfast.xml 1.10 04/03/23 16:02:26 Administrator@athena. +214 -15 Completed contributor tools section Prepared other toolset sectionsrest of toolset sections Docs/html.css 1.1 04/03/23 12:34:29 Administrator@athena. +595 -0 Docs/html.css 1.0 04/03/23 12:34:29 Administrator@athena. +0 -0 BitKeeper file C:/cygwin/home/Administrator/mysqldoc/Docs/html.css # This is a BitKeeper patch. What follows are the unified diffs for the # set of deltas contained in the patch. The rest of the patch, the part # that BitKeeper cares about, is below these diffs. # User: Administrator # Host: athena. # Root: C:/cygwin/home/Administrator/mysqldoc --- New file --- +++ Docs/html.css 04/03/23 12:34:29 /*********************************************************************** main.css ***********************************************************************/ body,th,td,div,p,h1,h2,li,dt,dd { font-family: Arial, sans-serif; } body { margin: 15px; color: #333333; background-color: #ffffff; } img.box { vertical-align: middle; } a:link { color: #006486; } a:active { color: #1d93b6; } a:hover { color: #64bfdb; } a:visited { color: #4e5265; } /* work around issue with docbook-generated pages */ a[id]:hover { color: inherit; } a img { border: 0px; color: #ffffff; /* makes border disappear in ns4 (sometimes) */ } h1, h2 { font-size: larger; } ul { list-style-image: url(box.png); list-style-type: square; } table.data { border-collapse: collapse; border: 1px solid #bdcebb; } table.data th { border: 1px solid #bdcebb; background: #cbdac9; } table.data td { border: 1px solid #bdcebb; background: #e3ebe2; } input.required, textarea.required { background: #e3ebe2; } input.bad, textarea.bad { background: #ffcd76; } .error, .errors { color: #e18a07; } p.byline { font-size: smaller; font-weight: bold; } #header { width: 100%; border: 0px; margin: 0px; padding: 0px; border-spacing: 0px; } #header td { padding: 0px; font-size: 12px; } #header #logo { vertical-align: middle; } #header #logo img { /*/*/ margin: 2px 15px; border: none; /* workaround for layout quirk in ie5.5 */ /* stupid ns4. */ } #header #tagline { font-size: 12px; font-weight: bold; font-style: italic; color: #006486; white-space: nowrap; } #header #navigation { color: #666666; text-align: right; white-space: nowrap; } #header #searchfields { padding: 0px 10px; } #search { margin: 0px; } #search #q { font-size: 11px; /*/*/ width: 100px; padding: 3px 4px; border: 1px solid #bdcebb; /* stupid ns4. */ } #search #submit { background: #bdcebb; color: #ffffff; font-weight: bold; /*/*/ border: 1px outset #bdcebb; font-size: 10px; voice-family: "\"}\""; voice-family: inherit; padding: 3px 4px; /* stupid ns4. */ } #header #topnav { vertical-align: bottom; } #topnav table { border-spacing: 0px; height: 18px; } #topnav td { padding: 2px 8px; background-color: #e2e9eb; white-space: nowrap; border: none; font-size: 12px; text-align: center; } #topnav td.sep { padding: 0px; } #topnav td.sep img { display: block; } #topnav td.a { background-color: #1d93b6; } #topnav td.s { background-color: #bdcebb; } #topnav a:link { text-decoration: none; color: #000000; } #topnav a:visited { text-decoration: none; color: #000000; } #topnav a:hover { text-decoration: underline; color: #000000; } #topnav td.a a:link { text-decoration: none; color: #ffffff; } #topnav td.a a:visited { text-decoration: none; color: #ffffff; } #topnav td.a a:hover { text-decoration: underline; color: #ffffff; } #topnav td.s a:link { text-decoration: none; color: #000000; } #topnav td.s a:visited { text-decoration: none; color: #000000; } #topnav td.s a:hover { text-decoration: underline; } #subnav { background-color: #1d93b6; height: 19px; vertical-align: bottom; } #subnav #right { width: 100%; } #subnav td { font-size: 12px; padding: 0px 4px 0px 10px; border-bottom: 1px solid #2a5a8a; vertical-align: bottom; white-space: nowrap; } #subnav td.sep { padding: 0px; border-bottom: 1px solid #ffffff; border-bottom: none; } #subnav td.sep img { padding: 0px; display: block; } #subnav td.u { background: #ffffff; padding-left: 0px; border-bottom: 1px solid #ffffff; } #subnav img { vertical-align: bottom; } #subnav a:link { text-decoration: none; color: #ffffff; } #subnav a:visited { text-decoration: none; color: #ffffff; } #subnav a:hover { text-decoration: underline; } #subnav td.p { background: #e2e9eb; padding-left: 0px; border-bottom: 1px solid #e2e9eb; } #subnav td.u a:link, #subnav td.p a:link { text-decoration: none; color: #000000; } #subnav td.u a:visited, #subnav td.p a:visited { text-decoration: none; color: #000000; } #subnav td.u a:hover, #subnav td.p a:hover { text-decoration: underline; } .shim { clear: both; } #contents { position: relative; } #contentspacer { float: left; width: 0px; height: 500px; } #body { margin: 10px 30px; } #content { border: none; padding-right: 19px; margin: 10px 240px 10px 30px; border-right: 1px solid #e3ebe2; } h1.title { color: #1d93b6; } h1.title { position: relative; left: -10px; } #sidebar { border: none; margin-top: 10px; margin-right: 10px; width: 220px; /*/*/ position: absolute; left: auto; right: 0px; top: 0px; } /* */ div.promo { margin-top: 10px; background: #e4ebe4; border: none; padding: 10px; } div.promo p { margin-top: 0px; } #sidebar #related h2 { font-size: larger; border-bottom: 1px solid #e4ebe4; } #sidebar #related ul { list-style-type: none; list-style-image: none; margin-left: 0px; padding-left: 0px; } #footer { font-size: smaller; clear: both; border: none; background: #e3ebe2; margin-top: 20px; padding-left: 30px; padding-top: 10px; padding-bottom: 10px; } #footer a:link { color: #666666; } #footer a:active, .footer a:hover { color: #006486; } #footer a:visited { color: #949494; } /********************************************************************* documentation.css *********************************************************************/ #toc { float: left; font-size: smaller; width: 205px; } #toc #doctop { border-bottom: 3px double #cccccc; } #toc #docup { border-bottom: 1px solid #cccccc; } #toc img { margin-left: -10px; padding-right: 5px; } #toc div { padding: 10px 0px; } #innertoc ul { margin: 0px; padding: 0px; list-style-type: none; list-style-image: none; } #toc ul.children { margin-left: 10px; } #toc #promo { text-align: center; } #doccontent { /* left margin has enough room to fit the toc */ margin: 15px 15px 15px 220px; border-left: 1px solid #cccccc; padding-left: 19px; } #docnav { font-size: smaller; } #docsearch { font-size: smaller; } #docsearch fieldset { border: none; } #docsearch label { position: static; } #docsearch #searchq { font-size: 11px; /*/*/ width: 120px; padding: 3px 4px; border: 1px solid #bdcebb; /* stupid ns4. */ } #docsearch #searchsubmit { background: #bdcebb; color: #ffffff; font-weight: bold; /*/*/ border: 1px outset #bdcebb; font-size: 10px; padding: 3px 4px; /* stupid ns4. */ } #langs, #formats { border-top: 3px double #cccccc; } #langs h2, #formats h2 { margin: 0px; } #langs ul, #formats ul { padding-left: 2em; } code { color: purple; } /* Need to comment this out because Norman Walsh's XSL style sheets love tt tt { color: green; } */ samp { color: navy; } pre { color: maroon; } #comments { background: #dbe6d9; padding: 0px 8px; } #comments h2 { border-bottom: 1px solid #cccccc; } .commentdetails { font-size: smaller; font-weight: bold; } .commenttext { margin-left: 10px; } /********************************************************************* Additions Author : Stefan Hinz Purpose : Account for classes used in MySQL GUI tool documentation Note : You can show/hide remarks with display property all/none Last edited : 2004-02-10 *********************************************************************/ .guibutton { border : 1px solid; border-left-color : #ffffff; border-top-color : #ffffff; border-right-color : #000000; border-bottom-color : #000000; padding-top : 1px; padding-bottom : 1px; padding-left : 6px; padding-right : 6px; color : #000000; background-color : #cccccc; font-family : "MS Sans Serif", sans-serif; font-size : 12px; font-style : normal; white-space : nowrap; } .guilabel { border : 1px solid; border-left-color : #cccccc; border-top-color : #cccccc; border-right-color : #eeeeee; border-bottom-color : #eeeeee; padding-top : 1px; padding-bottom : 1px; padding-left : 6px; padding-right : 6px; color : #000000; background-color : #eeeeee; font-family : "MS Sans Serif", sans-serif; font-size : 12px; font-style : normal; white-space : nowrap; } .guimenu { border : 1px solid; border-left-color : #cccccc; border-top-color : #cccccc; border-right-color : #eeeeee; border-bottom-color : #eeeeee; padding-top : 1px; padding-bottom : 1px; padding-left : 6px; padding-right : 6px; color : #000000; background-color : #cccccc; font-family : "MS Sans Serif", sans-serif; font-size : 12px; font-style : normal; white-space : nowrap; } .keycap { border : 1px solid black; padding-top : 1px; padding-bottom : 1px; padding-left : 6px; padding-right : 6px; color : white; background-color : black; font-family : "MS Sans Serif", sans-serif; font-size : 12px; font-style : normal; white-space : nowrap; } .command { color : purple; font-family : "Lucida Console", monospace; font-size : smaller; font-weight : normal; } .literal { color : purple; font-family : "Lucida Console", monospace; font-size : smaller; font-weight : normal; } .replaceable { font-family : "Lucida Console", monospace; font-size : normal; font-weight : normal; } tt { font-family : "Lucida Console", monospace; font-weight : normal; } .remark { font-style : italic; font-weight : bolder; color : red; display : visible; } .worklog { font-weight : bold; color : green; display : visible; } --- 1.9/Docs/slartibartfast.xml Mon Mar 22 18:58:22 2004 +++ 1.10/Docs/slartibartfast.xml Tue Mar 23 16:02:26 2004 @@ -120,16 +120,16 @@ The concepts in those chapters might also be interesting for people contributing other MySQL documentation. - Everyone editing the English manual and translators should read the appropriate sections of the Slartibartfast Toolset chapter. For contributors to the English manual, the Tools for Contributors section is the most interesting part, while for translators, the Tools for Translators section is more important. + Everyone editing the English manual and translators should read the appropriate sections of the Slartibartfast Toolset chapter. For contributors to the English manual, the Tools for Contributors section is the most interesting part, while for translators, the Tools for Translators section is more important. Everyone who wants to produce output (HTML, PDF, CHM, and so forth) from the XML should read the Output Generators section of the Slartibartfast Toolset chapter. - Everyone editing the English manual should read the Conventions for Contributors appendix. The conventions listed there are also interesting for people contributing other MySQL documentation. + Everyone editing the English manual should read the Conventions for Contributors appendix. The conventions listed there are also interesting for people contributing other MySQL documentation. - Translators should read the Conventions for Translators appendix. + Translators should read the Conventions for Translators appendix. @@ -311,7 +311,7 @@ Tools that help them make sure they don't mess up the manual (well-formedness, validity) - + Design Goals for Translators The tasks of translators regarding the manual are: @@ -1540,7 +1540,7 @@ - + Tools for Contributors The tools running on contributors' machines are designed to run platform-independent. See the Software Requirements section for a list of the software that needs to be installed so that the tools will run. @@ -1548,9 +1548,8 @@ The contributor tools consist of two sets: One set of tools makes sure contributions to the manual are in a consistent state before such contributions are pushed to the central English repository. The other set of tools helps contributors to work with the manual in various ways. Both sets of tools reside on the local machines of those who contribute to the manual, and thus work with the local repository clones. - + <literal>manual-contrib-literalentities.pl</literal> - [SH] Not programmed yet This script is not intended for daily use by contributors, but rather for enforcing consistency of terms in the English manual. @@ -1576,25 +1575,225 @@ From looking at that list, we might decide to encode both MySQL and MySQL server as XML entities, thus writing them as &mysql; and &mysql-server; in the manual, and defining those entities in the words.ent file. - For more information on words.ent, see the words.ent section. + For more information on XML entities and the words.ent file, see the words.ent section. + + + This tools has not been programmed yet. + + + STATUS: assigned + + + PRIORITY: low + + + DEPENDENCIES: none + + + COMPLETION: September 2004 + + + + <literal>manual-contrib-checkall.pl</literal> + + After having done an environment check (manual-helper-checkenv.pl) that must return without an error (otherwise the script will stop executing), this script does a bk ci for alle directories/files to determine which files have changed (and marks those as changed). Then it runs manual-helper-validate.pl and manual-helper-prettyprint.pl only for the files marked as changed. (This is done for performance reasons.) If the script returns without an error for the validation part, that means that the edits made left the XML consistent. Otherwise, it prints out which errors occurred (by using xmllint), and ex! its. The script invokes the following helper scripts: + + + manual-helper-checkenv.pl + + + manual-helper-validate.pl + + + manual-helper-prettyprint.pl + + + + + This script might also be used for translators. + + + This tools has not been programmed yet. + + + STATUS: assigned, helper tools almost completed + + + PRIORITY: high + + + DEPENDENCIES: helper tools must be completed + + + COMPLETION: April 2004 + + + + + + <literal>manual-contrib-commit.pl</literal> + + Alleviates the tasks of checking-in, committing, and pushing edits of the manual. The script first calls manual-contrib-checkall.pl to make sure any edits made are in a valid and proper state. It then checks in the edits (by calling bk ci), commits them (by calling bk commit) and pushes them (by calling bk push). Before the push, it does a bk pull to make sure that the push will succeed. [SH] We need to find a way to handle resolving conflicts. + + + This tools has not been programmed yet. + + + STATUS: assigned + + + PRIORITY: medium + + + DEPENDENCIES: checkall script + + + COMPLETION: June 2004 + + + + + + <literal>manual-contrib-sml.pl</literal> + + This script is based on an idea of Jim Winstead. We will probably not implement that idea, though. This script would alleviate the task of adding new content without having to learn DocBook XML, by converting text written in a Wiki-like Simple Markup Language ("SML") to DocBook. + + + This is how "SML" text would look like: + +* Added option --nice to mysqld_safe to allow setting the niceness of + the mysqld process. (Thanks to Christian Hammers for providing the + initial patch) (Bug #627) +* RESET SLAVE now clears the Last_errno and Last_error fields in the + output of SHOW SLAVE STATUS. +* RAND() entries were not read correctly by mysqlbinlog from the + binary log which caused problems when restoring a table that was + inserted with RAND(). INSERT INTO t1 VALUES(RAND()). In replication + this worked ok. +* Fixed <= and &= to work correctly. + + The script would convert that into DocBook XML: + +<itemizedlist> + <listitem> + Added option <option>--nice</option> to <command>mysqld_safe</command> to allow setting the niceness of the <command>mysqld</command> process. (Thanks to Christian Hammers for providing the initial patch) <ulink url="http://bugs.mysql.com/627">(Bug #627)</ulink> + </listitem> + <listitem> + <command>RESET SLAVE</command> now clears the <literal>Last_errno</literal> and <literal>Last_error</literal> fields in the output of <command>SHOW SLAVE STATUS</command>. + </listitem> + <listitem> + <function>RAND()</function> entries were not read correctly by <command>mysqlbinlog</command> from the binary log which caused problems when restoring a table that was inserted with <function>RAND()</function>. <command>INSERT INTO <replaceable>t1</replaceable> VALUES(<function>RAND()</function>)</command>. In replication this worked ok. + </listitem> + <listitem> + Fixed <= and &= to work correctly. + </listitem> +</itemizedlist> + + + + This tools has not been programmed yet. + + + STATUS: cancelled + + + PRIORITY: low + + + DEPENDENCIES: none + + + COMPLETION: N/A + + + + + + Other Scripts + + In addition to the above scripts, contributors should be given a set of tools for convenience. Most of those tools will be benefitial for translators, too, so they are listed in the Helper Tools + + - + Tools for Translators The tools running on translators' machines are designed to run platform-independent. See the Software Requirements section for a list of the software that needs to be installed so that the tools will run. + + <literal>manual-translate-checkall.pl</literal> + + + + + <literal>manual-translate-diff.pl</literal> + + + + + <literal>manual-translate-sync.pl</literal> + + + Helper Tools + [SH] FILL IN introduction + + <literal>manual-helper-checkenv.pl</literal> + + + + + <literal>manual-helper-validate.pl</literal> + + + + + <literal>manual-helper-prettyprint.pl</literal> + + + + + <literal>manual-helper-find.pl</literal> + + + + + <literal>manual-helper-replace.pl</literal> + + + + + <literal>manual-helper-generatebook.pl</literal> + + + - + Reporting Tools + [SH] FILL IN introduction + + <literal>manual-report-statistics.pl</literal> + + + + + <literal>manual-report-translations.pl</literal> + + + + + <literal>manual-report-structure.pl</literal> + + + Output Generators @@ -1680,27 +1879,27 @@ Conventions for Working with the Manual - + Conventions for Contributors - + XML Consistency - + Consistency of Terms Used - + Templates for Adding New Contents - + Conventions for Translators