236567 - Section "2.4.1.2. Perl Modules on Win32" contains a mistake in ppm syntax

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Andrei Benea]

User-Agent:       Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) Opera 7.50  [en]
Build Identifier: 

The syntax present in the docs is incorrect:
C:\perl> ppm <module name>
It should be:
C:\perl> ppm install <module name>

Also, ppm install <module name> doesn't always find the module, even if it's 
available. For example:
C:\perl> ppm install Template
fails, but
C:\perl> ppm install Template-Toolkit
finds the right package.

I think this would be the best place to list the commands required to install 
the (ActiveState) packages needed for BugZilla.

Reproducible: Always
Steps to Reproduce:

Comment 1

[Vlad Dascalu]

Go for it!

Comment 2

[Andrei Benea]

Attachment: v1

This patch corrects both problems.

Comment 3

[Andrei Benea]

Attachment: v2

Comment 4

[Christian Reis]

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


Thanks for the patch.

>Index: webtools/bugzilla/docs/xml/installation.xml
>-C:\perl&gt; <command>ppm &lt;module name&gt;</command>
>+C:\perl&gt; <command>ppm install &lt;module name&gt;</command>

Nice catch!

>+	  <para>For example, the following commands will install all the
>+          required packages:
>+          </para>

Does it truly install *all* the required packages? AFAIK we require other
packages that aren't listed there: File::Spec, Text::Wrap, Data::Dumper, etc.

If we do include commands to install all the required packages, then I'd
suggest removing "For example" there.

Comment 5

[Andrei Benea]

Attachment: v3

Comment 6

[Andrei Benea]

Attachment: v3 corrected

Comment 7

[Christian Reis]

Comment on attachment 143020 [details] [diff] [review]
v3 corrected

Looks good and makes sense; thanks.

Comment 8

[Vlad Dascalu]

Woo, took me some months to checkin my first written patch for BZ! Nice! :-)

I'll eliminate the tabs when checking it in, besides the xml doc stuff has a lot
of other tabs as well, maybe we should open a new bug about that one.

Comment 9

[Vlad Dascalu]

And add a test for that to the testing suite, unless it skips docs for a reason.

Comment 10

[Dave Miller [:justdave]]

Probably wouldn't be a bad idea to correct the output of checksetup.pl when
running on Windows, too.  Need to file a separate bug for that though.

Comment 11

[Vlad Dascalu]

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

Comment 12

[Vlad Dascalu]

Attachment: Backported for the BUGZILLA-2_16-BRANCH

Comment 13

[Vlad Dascalu]

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