303782 - Docs missing prerequsite for required MIME::Base64 and MIME::Parser

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect, P3)

Description

[Joel Peshkin]

Docs need update

Comment 1

[victory <[e-mail]>]

Attachment: patch for tip

coordinate to checksetup.pl

Comment 2

[Colin Ogilvie [:cso]]

Comment on attachment 206696 [details] [diff] [review]
patch for tip

>Index: docs/xml/Bugzilla-Guide.xml

This looks fine...

>Index: docs/xml/installation.xml
     
>+            <link linkend="install-modules-mime-parser">MIME::Base64</link>

>+            <link linkend="install-modules-mime-parser">MIME::Parser</link>

>+            <link linkend="install-modules-image-magick">Image::Magick</link>
>+            (&min-image-magick-ver;) for convert BMP image attachments to PNG

Don't need the <link> elements... there's nothing to link to.

"for convert BMP" -> "for converting BMP"

Comment 3

[victory <[e-mail]>]

Attachment: v2

apply comments

Comment 4

[Colin Ogilvie [:cso]]

Comment on attachment 206865 [details] [diff] [review]
v2

>Index: docs/xml/installation.xml

>+
>+        <listitem>
>+          <para>
>+            MIME::Base64 (&min-mime-base64-ver;) for utf-8 encoding
>+          </para>
>+        </listitem>
>+
>+        <listitem>
>+          <para>
>+            MIME::Parser (&min-mime-parser-ver;) for email interface
>+          </para>
>+        </listitem>
>+

Can you kill the descriptions, since none of the other required modules have them?

Also, you forgot the Bugzilla-Guide.xml change in this patch ;)

Comment 5

[victory <[e-mail]>]

Attachment: patch for tip v3

argh..
perhaps I should have been slept at that time

Comment 6

[victory <[e-mail]>]

Attachment: added modules.xml

Comment 7

[Colin Ogilvie [:cso]]

Comment on attachment 206904 [details] [diff] [review]
added modules.xml

>Index: docs/xml/Bugzilla-Guide.xml

This is still fine :)

>Index: docs/xml/installation.xml

>         <listitem>
>           <para>
>-            <link linkend="install-modules-mime-parser">MIME::Parser</link>
>-            (&min-mime-parser-ver;) for the optional email interface
>+            Image::Magick (&min-image-magick-ver;) for converting BMP image attachments to PNG
>           </para>
>         </listitem>

I wonder if this needs a <section> like that for PatchReader just explaining that the mdoule is optional, and only required if you want to convert the images...

Thoughts?

>Index: docs/xml/modules.xml

>+   <para>
>+      Image::Magick:
>+      <literallayout>
>+        CPAN Download Page: <ulink url="http://search.cpan.org/dist/XML-Parser/"/>
>+        PPM Download Link: Included in Windows binary package.
>+        Documentation: <ulink url="http://www.imagemagick.org/script/resources.php"/>
>+      </literallayout>
>+    </para>

As per IRC, this should be http://search.cpan.org/dist/PerlMagick/ instead.

Comment 8

[victory <[e-mail]>]

Attachment: sorrrry for wrong patch and bug spam

correct information should be put there now, and bringing together those modules can be done when someone decide how to do.
so i don't touch about that right now ;-)

Comment 9

[Colin Ogilvie [:cso]]

Comment on attachment 207000 [details] [diff] [review]
sorrrry for wrong patch and bug spam

Looks good to me.

Comment 10

[Colin Ogilvie [:cso]]

Checked in:

Checking in docs/xml/Bugzilla-Guide.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/Bugzilla-Guide.xml,v  <--  Bugzilla-Guide.xml
new revision: 1.56; previous revision: 1.55
done
Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <--  installation.xml
new revision: 1.107; previous revision: 1.106
done
Checking in docs/xml/modules.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/modules.xml,v  <--  modules.xml
new revision: 1.4; previous revision: 1.3
done