297483 - Remove comment from installation.xml about 'module-check' switch being needed as it's already available

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Colin Ogilvie [:cso]]

<!-- We really need a "module-check" switch for checksetup, which we can use
here to make it really clear when they've got all the modules. -->

I suggest removing the comment and adding a description of the --check-modules
switch to the file, as well as using it in the command line above.

Comment 1

[Colin Ogilvie [:cso]]

Attachment: Patch v1

Comment 2

[Kevin Benton]

It seems this should be followed up with an addition / modification to
checksetup.pl to do a better job of explaining what to do in the event of a
MySQL connection failure.  See bug 297672 for a suggestion on what text to display.

Comment 3

[Colin Ogilvie [:cso]]

Whats that got to do with the bit on checking for modules?

Comment 4

[Zach Lipton [:zach]]

Comment on attachment 186070 [details] [diff] [review]
Patch v1

I'm not convinced this is a good idea, and I'm somewhat inclined to r- this.
checksetup will already tell you if all the modules are installed, so there's
not much point in making someone run it with --check-modules and then again
without it. Can't we just tell the user to run checksetup.pl, and if it tells
them that modules are required to go ahead and install them before running
checksetup again?

Comment 5

[Colin Ogilvie [:cso]]

Bug 232804 added the switch and specifically mentions that it would be useful to
document it. I'm not particularly bothered about the text rewording - just
removing the comment would do - but Gerv, who filed the original bug and fixed
it to add the switch, obviously did.

Adding him to CC for comments.

Comment 6

[Zach Lipton [:zach]]

I'm fine with rewording the text, but I think it just confuses people to say
that they should run checksetup with the switch and then without it. I would
just tell people to run it without it, see if they need to install anything, and
then run it again the same way they did before. If we want to document the
switch, we can always put a note in somewhere to explain that you can use it. 

Comment 7

[Gervase Markham [:gerv]]

The reason they run with the switch and then without it is to stage the
installation. Without the switch, it's very easy to run it one time too many and
accept the default "localconfig" instead of editing it first. This prevents that
possibility.

However, checking the latest manual, it seems that the advice to use the switch
has been removed?

Gerv

Comment 8

[Colin Ogilvie [:cso]]

(In reply to comment #7)
> However, checking the latest manual, it seems that the advice to use the switch
> has been removed?

Gerv

Was it ever added? That was one of the purposes of this bug - the other was to
remove the comment which is no longer valid...

Comment 9

[Gervase Markham [:gerv]]

Comment on attachment 186070 [details] [diff] [review]
Patch v1

This patch is good, but the "rerun without --check-modules" part should be in
section 2.2.1 (HTML numbering) - i.e. the first section in  configuration.xml.
There's already text in there about what happens when you've got all the
modules; modify that to say "when all the modules are installed, run
checksetup.pl again like this" and give the command line.

Gerv

Comment 10

[Colin Ogilvie [:cso]]

Attachment: Patch v2

Changes as suggested previously.

Comment 11

[Gervase Markham [:gerv]]

Colin: Patch v2 doesn't seem to implement comment #9, although your comment
suggested it would. What have I missed?

Gerv

Comment 12

[Colin Ogilvie [:cso]]

The second part of the diff is in the section referenced in Comment 9...

Comment 13

[Gervase Markham [:gerv]]

Comment on attachment 189320 [details] [diff] [review]
Patch v2

How right you are. Sorry. :-) r=gerv.

Gerv

Comment 14

[Colin Ogilvie [:cso]]

2.20:

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.98.2.3; previous revision: 1.98.2.2
done
[Finished]

Trunk:

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.101; previous revision: 1.100
done
[Finished]