X-Git-Url: https://git.sven.stormbind.net/?p=sven%2Fmysqltcl.git;a=blobdiff_plain;f=debian%2Fpatches%2Fman-hyphen-and-spelling;h=52bd694db972c06a7aba2a79141d994b04f42b12;hp=937e4270b56dad916dc9db58dc58ae9d8fb33daa;hb=HEAD;hpb=d023568f4134ac42286969e7e99c51a52ec8c6f5 diff --git a/debian/patches/man-hyphen-and-spelling b/debian/patches/man-hyphen-and-spelling index 937e427..52bd694 100644 --- a/debian/patches/man-hyphen-and-spelling +++ b/debian/patches/man-hyphen-and-spelling @@ -1,8 +1,10 @@ Fix some smaller issue in the manpage brought up by lintian. Mostly hyphen-as-minus and two spelling issue. ---- a/doc/mysqltcl.n -+++ b/doc/mysqltcl.n -@@ -396,17 +396,17 @@ The port number for the TCP/IP connectio +Index: mysqltcl/doc/mysqltcl.n +=================================================================== +--- mysqltcl.orig/doc/mysqltcl.n ++++ mysqltcl/doc/mysqltcl.n +@@ -358,17 +358,17 @@ The port number for the TCP/IP connectio The socket or named pipe for the connection. .TP \fB-encoding\fR \fIencodingname\fR @@ -24,7 +26,7 @@ Mostly hyphen-as-minus and two spelling issue. .TP \fB-compress\fR \fIboolean\fR Use compression protocol. Default is false -@@ -442,23 +442,23 @@ Switch to SSL after handshake. Default i +@@ -404,23 +404,23 @@ Switch to SSL after handshake. Default i .TP \fB-sslkey\fR \fIstring\fR is the pathname to the key file. @@ -50,23 +52,23 @@ Mostly hyphen-as-minus and two spelling issue. is a list of allowable ciphers to use for SSL encryption. -Used if -ssl is true +Used if \-ssl is true - .RE .TP - \fB::mysql::use\fR \fIhandle\fR \fIdatabase\fR -@@ -498,9 +498,9 @@ is useful for scanning with a single \fI - .RE + \fB-reconnect\fR \fIboolean\fR + default is false. +@@ -466,9 +466,9 @@ is useful for scanning with a single \fI Example: .nf + -% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -list +% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" \-list {1 Joe} {2 Phil} {3 John} -% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" -flatlist +% ::mysql::sel $db "SELECT ID, NAME FROM FRIENDS" \-flatlist {1 Joe 2 Phil 3 John} + .fi - Note that both list syntaxes are faster than something like -@@ -511,7 +511,7 @@ Note that both list syntaxes are faster - {1 Joe 2 Phil 3 John} +@@ -482,7 +482,7 @@ Note that both list syntaxes are faster + .fi If \fIsql-statement\fR is a valid MySQL statement, but not a SELECT -statement, the command returns -1 after executing the statement, or an empty @@ -74,7 +76,16 @@ Mostly hyphen-as-minus and two spelling issue. string if \fI-list\fR or \fI-flatlist\fR is specified. There is no pending result in this case. .sp -@@ -593,7 +593,7 @@ The first variable in the binding list i +@@ -513,7 +513,7 @@ In case of multiple statement ::mysql::e + \fB::mysql::query\fR \fIhandle\fR \fIsql-select-statement\fR + Send \fIsql-select-statement\fR to the server. + .sp +-\fImysql::query\fR allow to send multiple nested queries on one handle (without need to build ++\fImysql::query\fR allow one to send multiple nested queries on one handle (without need to build + new handle or caching results). + mysql::query return a query handle that can be used as handle in commands as (mysql::fetch, + ::mysql::map, mysql::seek, mysql::col, mysql::result). +@@ -566,7 +566,7 @@ The first variable in the binding list i the row, and so on. The variables are created in the current context (if they do not already exist). @@ -83,16 +94,19 @@ Mostly hyphen-as-minus and two spelling issue. placeholder in the binding list. If there are more columns than variables the extra columns are ignored. -@@ -641,7 +641,7 @@ This command can be faster as using of : +@@ -614,9 +614,9 @@ from server. + There is also no client cache. + This command can be faster as using of ::mysql::sel and by very big resultset will not overload client machine. - The scipt should process the result immadiatly because +-The scipt should process the result immadiatly because ++The scipt should process the result immediately because it can block table (or tables) for another clients. -If performance matter please test all alternatives separatly. +If performance matter please test all alternatives separately. You must consider two aspects: memory consumption and performance. .TP \fB::mysql::seek\fR \fIhandle\fR \fIrow-index\fR -@@ -653,8 +653,8 @@ Row index 0 is the position just before +@@ -628,8 +628,8 @@ Row index 0 is the position just before row index 1 is the position just before the second row, and so on. You may specify a negative row index. @@ -103,16 +117,16 @@ Mostly hyphen-as-minus and two spelling issue. and so on. An out-of-bounds row index will cause ::mysql::seek to set the new current position either just before the first row (if the index is too negative), -@@ -740,7 +740,7 @@ name lname area phone +@@ -716,7 +716,7 @@ name lname area phone % ::mysql::col $db friends {name type length} {fname char 12} {lname char 20} {area char 5} {phone char 12} % ::mysql::sel $db {select * from friends} -% ::mysql::col $db -current name type length +% ::mysql::col $db \-current name type length {fname lname area phone} {char char char char} {12 20 5 12}] + .fi - .TP -@@ -918,7 +918,7 @@ Rollback the current transaction. +@@ -895,7 +895,7 @@ Rollback the current transaction. .TP \fB::mysql::nextresult\fR \fIhandle\fR If more query results exist, mysql::nextresult() reads the next query results and returns the status back to application. @@ -121,7 +135,7 @@ Mostly hyphen-as-minus and two spelling issue. .TP \fB::mysql::moreresult\fR \fIhandle\fR Returns true if more results exist from the currently executed query, and the application must call mysql::result to fetch the results. -@@ -951,7 +951,7 @@ if {[mysql::isnull $row]} { +@@ -930,7 +930,7 @@ if {[mysql::isnull $row]} { create new null object. It can be used to simulate returned row contents. .TP \fB::mysql::setserveroption\fR \fIhandle\fR \fIoption\fR @@ -130,7 +144,7 @@ Mostly hyphen-as-minus and two spelling issue. .TP \fB::mysql::shutdown\fR \fIhandle\fR Asks the database server to shut down. The connected user must have SHUTDOWN privileges. -@@ -974,7 +974,7 @@ All conflicts also generate a Tcl error. +@@ -954,7 +954,7 @@ All conflicts also generate a Tcl error. All MySQL server conflicts set mysqlstatus(code) to the numeric code of the MySQL error. .sp @@ -139,3 +153,12 @@ Mostly hyphen-as-minus and two spelling issue. .TP command The last failing mysqltcl command. +@@ -973,7 +973,7 @@ You may set it to another value. + .PP + .SH "Backward compatibility" + Up from version 3.0 all mysql commands are declared in ::mysql namespace. +-All names for example mysqlconnect are also aviable but deprecated. ++All names for example mysqlconnect are also available but deprecated. + All old commands have the name pattern mysql{name} and the most of them are now mysql::{name}. + The exception is mysqlnext, which was renamed to mysql::fetch. + .SH "BUGS & POSSIBLE MISFEATURES"