247923 - Note max_allowed_packet option has different syntax for MySQL 4

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect, P2)

Description

[Jeroen Ruigrok van der Werven]

User-Agent:       Opera/7.50 (X11; DragonFly i386; U)  [en]
Build Identifier: 

On the provided URL, under section 2.2.2.2, the documentation states:

2.2.2.2. Allow large attachments

You need to configure MySQL to accept large packets, if you want to have 
attachments larger than 64K. Add the text below to your /etc/my.cnf. There is 
also a parameter in Bugzilla for setting the maximum allowable attachment size, 
(default 1MB). Bugzilla will only accept attachments up to the lower of these 
two sizes. 

[mysqld]
# Allow packets up to 1M
set-variable = max_allowed_packet=1M

Per MySQL's documentation (http://dev.mysql.com/doc/mysql/en/Option_files.html):
"set-variable = var_name=value 
Set the program variable var_name to the given value. This is equivalent to 
--set-variable=var_name=value on the command line. Spaces are allowed around the 
first `=' character but not around the second. This syntax is deprecated as of 
MySQL 4.0. See section 4.3.4 Using Options to Set Program Variables for more 
information on setting program variables."

This should be changed to:

[mysqld]
# Allow packets up to 1M
max_allowed_packet=1M

Reproducible: Always
Steps to Reproduce:
1.
2.
3.

Comment 1

[Max Kanat-Alexander]

That's only deprecated as of MySQL 4. We don't require MySQL 4, yet.

Comment 2

[Jeroen Ruigrok van der Werven]

True, but a lot of new installations will deploy 4.0.x and not 3.x.
Perhaps add a 'for 3.x do', 'for 4.x do' part?  So we cater for both situations.

Comment 3

[Max Kanat-Alexander]

OK, yeah, that sounds like a good idea.

Comment 4

[Jacob Steenhagen]

They always have to change things, don't they? Just to clarify, the syntax in
there now is for 3.x and the syntax included in comment 0 is for 4.x?

Comment 5

[Vlad Dascalu]

Travis did recently a very similar patch to the one that's needed here, as far
as I can remember.

Comment 6

[Jeroen Ruigrok van der Werven]

Jacob, you are correct.  The current syntax is for 3.x, the way I described in
my comment is for 4.x.

Comment 7

[Shane H. W. Travis]

(In reply to comment #5)
> Travis did recently a very similar patch to the one that's needed here

bug 266461, in case anyone wants to make this change consistent with that one.

Comment 8

[Shane H. W. Travis]

Attachment: Doc changes for 2.18 and tip

Adds the new information and rewords the relevant section for clarity. Also
fixed indenting and wrapping on this section.

Comment 9

[Shane H. W. Travis]

Attachment: Doc changes for 2.16

Same information back-ported to the 2.16 docs, which were different in words
(but not in intent) from the 2.18/tip docs. (Harder to make patches when
they're not all the same... :(

Also cleaned up indentation and wrapping here, but in a much smaller area.

Comment 10

[Jacob Steenhagen]

Comment on attachment 168831 [details] [diff] [review]
Doc changes for 2.18 and tip

>         modules installed, it displays a message about, and write out a 

*nit* (I know it's not something you changed). "[...] it displays a message
about, and writes out [...]"

>+        <para>
>+          By default, MySQL will only accept packets up to 64Kb in size.
>+          If you want to have attachments larger than this, you will need
>+          to modify your <filename>/etc/my.cnf</filename> as below.
>         </para>
> 
>-          <screen>  [mysqld]
>+        <para>
>+          If you are using MySQL 4.0 or newer, enter:
>+        </para>
>+        <screen>  [mysqld]
>+  # Allow packets up to 1M
>+  max_allowed_packet=1M</screen>
>+
>+        <para>
>+          If you are using an older version of MySQL, enter:
>+        </para>
>+        <screen>  [mysqld]
>   # Allow packets up to 1M
>   set-variable = max_allowed_packet=1M</screen>
>+
>+        <para>
>+          There is also a parameter in Bugzilla called 'maxattachmentsize'
>+          (default = 1000 Kb) that controls the maximum allowable attachment
>+          size. Attachments larger than <emphasis>either</emphasis> the 
>+          'max_allowed_packet' or 'maxattachmentsize' value will not be
>+          accepted by Bugzilla.
>+        </para>
>       </section>

*nit* I'd like to see these be <example/>s. See the erroneous
http://bonsai.mozilla.org/cvsblame.cgi?file=mozilla/webtools/bugzilla/docs/xml/
security.xml&rev=1.2&mark=136-165#135 for an an example of how I intended to do
it.

>+          has no such limit or if you are using RAID.  To set a higher

*nit* I still don't know what RAID has to do w/anything :)

I guess all I have is three nits. the <example/> one is probably the biggest
one. However, being that there are a lot of places where this isn't currently
used, not using it here won't end the world ;)

Comment 11

[Jacob Steenhagen]

Fixed in Tip and 2.18 (attachment 168831 [details] [diff] [review])

Checking in installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.85; previous revision: 1.84
done


Checking in xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.72.2.13; previous revision: 1.72.2.12
done

Comment 12

[Jacob Steenhagen]

And in 2.16

Checking in xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.18.2.22; previous revision: 1.18.2.21
done