summaryrefslogtreecommitdiff
path: root/Docs
diff options
context:
space:
mode:
authorunknown <Administrator@co3064164-a.rochd1.qld.optushome.com.au>2001-10-26 13:48:32 +1000
committerunknown <Administrator@co3064164-a.rochd1.qld.optushome.com.au>2001-10-26 13:48:32 +1000
commit16a1f41f7a6328ac4322915d8eb78a3906968aa9 (patch)
tree2f2f9c3022e87a9e19013a8267fb836c090bc6ce /Docs
parent710bea33114d6dd82e9056888dd119a2e45a3111 (diff)
downloadmariadb-git-16a1f41f7a6328ac4322915d8eb78a3906968aa9.tar.gz
Fixup of lingo (PR clean) in "-- as the start of a comment" text.
Diffstat (limited to 'Docs')
-rw-r--r--Docs/manual.texi39
1 files changed, 20 insertions, 19 deletions
diff --git a/Docs/manual.texi b/Docs/manual.texi
index c9e2a959e39..474bf541969 100644
--- a/Docs/manual.texi
+++ b/Docs/manual.texi
@@ -4025,37 +4025,38 @@ system. @xref{Privilege system}.
@cindex comments, starting
@cindex starting, comments
-Some other SQL databases use @samp{--} to start comments. MySQL
-has @samp{#} as the start comment character, even if the @code{mysql}
-command-line tool removes all lines that start with @samp{--}.
-You can also use the C comment style @code{/* this is a comment */} with
-MySQL.
+Some other SQL databases use @samp{--} to start comments.
+MySQL has @samp{#} as the start comment character. You can also use
+the C comment style @code{/* this is a comment */} with MySQL.
@xref{Comments}.
-MySQL Version 3.23.3 and above supports the @samp{--} comment style
-only if the comment is followed by a space. This is because this
-degenerate comment style has caused many problems with automatically
-generated SQL queries that have used something like the following code,
-where we automatically insert the value of the payment for
+MySQL Version 3.23.3 and above supports the @samp{--} comment style,
+provided the comment is followed by a space. This is because this
+comment style has caused many problems with automatically generated
+SQL queries that have used something like the following code, where
+we automatically insert the value of the payment for
@code{!payment!}:
@example
UPDATE tbl_name SET credit=credit-!payment!
@end example
-What do you think will happen when the value of @code{payment} is negative?
+Think about what happens if the value of @code{payment} is negative?
+Because @code{1--1} is legal in SQL, the consequences of allowing
+comments to start with @samp{--} are terrible.
+
+Using our implementation of this method of commenting in MySQL
+Version 3.23.3 and up, @code{1-- This is a comment} is actually safe.
-Because @code{1--1} is legal in SQL, we think it is terrible that
-@samp{--} means start comment.
+Another safe feature is that the @code{mysql} command-line client
+removes all lines that start with @samp{--}.
-In MySQL Version 3.23 you can, however, use:
-@code{1-- This is a comment}
-The following discussion only concerns you if you are running a MySQL
-version earlier than Version 3.23:
+The following information is only relevant if you are running a
+MySQL version earlier than Version 3.23.3:
-If you have a SQL program in a text file that contains @samp{--} comments
-you should use:
+If you have a SQL program in a text file that contains @samp{--}
+comments you should use:
@example
shell> replace " --" " #" < text-file-with-funny-comments.sql \