From c9836d5962f27d5d24d1c28d2cf0066528d803b5 Mon Sep 17 00:00:00 2001 From: Paul Jacobs Date: Fri, 29 May 2020 15:03:43 +0300 Subject: [PATCH] PT-1851 Formatting escape chars as code. Other fixes for Sphinx warnings. --- bin/pt-archiver | 14 ++++++++------ bin/pt-kill | 4 ++-- bin/pt-online-schema-change | 2 +- bin/pt-slave-delay | 2 +- bin/pt-stalk | 2 +- bin/pt-table-checksum | 5 +++-- docs/index.rst | 2 ++ docs/release_notes.rst | 9 ++++----- 8 files changed, 22 insertions(+), 18 deletions(-) diff --git a/bin/pt-archiver b/bin/pt-archiver index 646d4106..42cb4ba1 100755 --- a/bin/pt-archiver +++ b/bin/pt-archiver @@ -7696,8 +7696,8 @@ Example: The file's contents are in the same format used by SELECT INTO OUTFILE, as documented in the MySQL manual: rows terminated by newlines, columns -terminated by tabs, NULL characters are represented by \N, and special -characters are escaped by \. This lets you reload a file with LOAD DATA +terminated by tabs, NULL characters are represented by C<\N>, and special +characters are escaped by C<\>. This lets you reload a file with LOAD DATA INFILE's default settings. If you want a column header at the top of the file, see L<"--header">. The file @@ -7856,8 +7856,10 @@ type: string Used with L<"--file"> to specify the output format. Valid formats are: - dump: MySQL dump format using tabs as field separator (default) - csv : Dump rows using ',' as separator and optionally enclosing fields by '"'. + +- dump: MySQL dump format using tabs as field separator (default) + +- csv : Dump rows using ',' as separator and optionally enclosing fields by '"'. This format is equivalent to FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '"'. =item --password @@ -7887,10 +7889,10 @@ Specify the Perl module name of a general-purpose plugin. It is currently used only for statistics (see L<"--statistics">) and must have C and a C method. -The C $src, dst => $dst, opts => $o )> method gets the source +The C $src, dst =E $dst, opts =E $o )> method gets the source and destination DSNs, and their database connections, just like the connection-specific plugins do. It also gets an OptionParser object (C<$o>) for -accessing command-line options (example: C<$o->get('purge');>). +accessing command-line options (example: C<$o-Eget('purge');>). The C method gets a hashref of the statistics collected by the archiving job, and the time the whole job started. diff --git a/bin/pt-kill b/bin/pt-kill index 573ce6d6..5cbf8ea9 100755 --- a/bin/pt-kill +++ b/bin/pt-kill @@ -8323,9 +8323,9 @@ Print information to STDOUT about what is being done. These actions are taken for every matching query from all classes. The actions are taken in this order: L<"--print">, L<"--execute-command">, -L<"--kill">/L<"--kill-query">. This order allows L<"--execute-command"> +L<"--kill"> / L<"--kill-query">. This order allows L<"--execute-command"> to see the output of L<"--print"> and the query before -L<"--kill">/L<"--kill-query">. This may be helpful because pt-kill does +L<"--kill"> / L<"--kill-query">. This may be helpful because pt-kill does not pass any information to L<"--execute-command">. See also L<"GROUP, MATCH AND KILL">. diff --git a/bin/pt-online-schema-change b/bin/pt-online-schema-change index ee920765..bd9e01af 100755 --- a/bin/pt-online-schema-change +++ b/bin/pt-online-schema-change @@ -11918,7 +11918,7 @@ The tool exits with an error if the host is a cluster node and the table is MyISAM or is being converted to MyISAM (C), or if C is not C. There is no way to disable these checks. -=head1 MySQL 5.7+ Generated columns +=head1 MySQL 5.7 + Generated columns The tools ignores MySQL 5.7+ C columns since the value for those columns is generated according to the expresion used to compute column values. diff --git a/bin/pt-slave-delay b/bin/pt-slave-delay index b14301ad..275316ba 100755 --- a/bin/pt-slave-delay +++ b/bin/pt-slave-delay @@ -4602,7 +4602,7 @@ server. Before using this tool, please: C watches a slave and starts and stops its replication SQL thread as necessary to hold it at least as far behind the master as you request. In practice, it will typically cause the slave to lag between -L<"--delay"> and L<"--delay">+L<"--interval"> behind the master. +L<"--delay"> and L<"--delay"> + L<"--interval"> behind the master. It bases the delay on binlog positions in the slave's relay logs by default, so there is no need to connect to the master. This works well if the IO diff --git a/bin/pt-stalk b/bin/pt-stalk index e1bc7ab0..40e783dc 100755 --- a/bin/pt-stalk +++ b/bin/pt-stalk @@ -1993,7 +1993,7 @@ then compared to L<"--threshold"> as usual. The C<$EXT_ARGV> variable contains the MySQL options mentioned in the L<"SYNOPSIS"> above. The file should not alter the tool's existing global variables. Prefix any -file-specific global variables with "PLUGIN_" or make them local. +file-specific global variables with C or make them local. =item --help diff --git a/bin/pt-table-checksum b/bin/pt-table-checksum index cb947fc0..59b34b32 100755 --- a/bin/pt-table-checksum +++ b/bin/pt-table-checksum @@ -13324,7 +13324,8 @@ first option on the command line. See the L<"--help"> output for a list of default config files. -=item --[no]create-replicate-table +=item --create-replicate-table +=item --no-create-replicate-table default: yes @@ -13687,7 +13688,7 @@ structure (MAGIC_create_replicate): Note: lower_boundary and upper_boundary data type can be BLOB. See L<"--binary-index">. -By default, L<"--[no]create-replicate-table"> is true, so the database and +By default, L<"--create-replicate-table"> is true, so the database and the table specified by this option are created automatically if they do not exist. diff --git a/docs/index.rst b/docs/index.rst index 790e1df1..0bafa0b8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -59,6 +59,8 @@ Miscellaneous :maxdepth: 2 bugs + ipv6_support + special_option_types authors copyright_license_and_warranty version diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 1ca99f8d..fbb87975 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -110,8 +110,7 @@ New features * :jirabug:`PT-1571`: Improved hostname recognition in ``pt-secure-collect`` * :jirabug:`PT-1569`: Disabled ``--alter-foreign-keys-method=drop_swap`` in ``pt-online-schema-change`` -* :jirabug:`PT-242`: (``pt-stalk``) Include ``SHOW SLAVE STATUS`` on MySQL 5.7 (Thanks `Marcelo Altmann `_) +* :jirabug:`PT-242`: (``pt-stalk``) Include ``SHOW SLAVE STATUS`` on MySQL 5.7 (Thanks `Marcelo Altmann `_) Fixed bugs @@ -1138,17 +1137,17 @@ pt-query-digest --output json includes query examples as of v2.2.3. Some people When using drop swap with pt-online-schema-change there is some production impact. This impact can be measured because tool outputs the current timestamp on lines for operations that may take awhile. * Fixed bug #1163735: pt-table-checksum fails if explicit_defaults_for_timestamp is enabled in 5.6 -pt-table-checksum would fail if variable explicit_defaults_for_timestamp was enabled in MySQL 5.6. + pt-table-checksum would fail if variable explicit_defaults_for_timestamp was enabled in MySQL 5.6. * Fixed bug #1182856: Zero values causes "Invalid --set-vars value: var=0" -Trying to assign 0 to any variable by using --set-vars option would cause “Invalid --set-vars value” message. + Trying to assign 0 to any variable by using --set-vars option would cause “Invalid --set-vars value” message. * Fixed bug #1188264: pt-online-schema-change error copying rows: Undefined subroutine &pt_online_schema_change::get * Fixed the typo in the pt-online-schema-change code that could lead to a tool crash when copying the rows. * Fixed bug #1199591: pt-table-checksum doesn't use non-unique index with highest cardinality -pt-table-checksum was using the first non-unique index instead of the one with the highest cardinality due to a sorting bug. + pt-table-checksum was using the first non-unique index instead of the one with the highest cardinality due to a sorting bug. Percona Toolkit packages can be downloaded from http://www.percona.com/downloads/percona-toolkit/ or the Percona Software