285466 - Add documentation for --regenerate option to collectstats.pl

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Shane H. W. Travis]

This bug tracks the documentation additions needed for bug 80157.

Comment 1

[victory <[e-mail]>]

Attachment: patch for tip

Comment 2

[Colin Ogilvie [:cso]]

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

>+      <para>
>+        When upgrading Bugzilla, this format may change.
>+        To create new status data, (re)move old data and run following commands:
>+      </para>
>+
>+      <screen>
>+        <prompt>bash$</prompt>
>+        <command>cd &lt;your-bugzilla-directory&gt;</command>
>+        <prompt>bash$</prompt>
>+        <command>./collectstats.pl --regenerate</command>
>+      </screen>
>+

should be "run the following" but other than that, it looks good and compiles correctly.

Comment 3

[Colin Ogilvie [:cso]]

Checked in:

Trunk:

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

2.20:

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

2.18

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

Comment 4

[Frédéric Buclin]

What the patch says is completely wrong. You don't have to pass --regenerate when upgrading. This overrides all the current data, which is something you don't want, and it requires several *days* to complete on large installations. You should *only* use it if you deleted your data by accident and want to regenerate them, as the option says.

Backing out the patch on all branches (a=mkanat on IRC).

tip:

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

3.2rc1:

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

3.0.5:

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

2.22.5:

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

2.20.6:

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

Comment 5

[Frédéric Buclin]

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

See my previous comment.

Comment 6

[Frédéric Buclin]

Also, the documentation should be in collectstats.pl itself, and be accessible using ./collectstats.pl --help.

Comment 7

[Frédéric Buclin]

Attachment: patch, v1

This patch also removes the obsolete comment which I forgot to remove while fixing bug 672173.

Comment 8

[Max Kanat-Alexander]

Comment on attachment 548330 [details] [diff] [review]
patch, v1

There's a way to write POD that generates much better Options stuff than that and is still viewable in web format. A few of our command-line scripts are using it. I think contrib/recode is one of them.

Comment 9

[Frédéric Buclin]

Attachment: patch, v2

Comment 10

[Gervase Markham [:gerv]]

Comment on attachment 548345 [details] [diff] [review]
patch, v2

Looks OK to me :-)

Gerv

Comment 11

[Frédéric Buclin]

Thanks :)

Comment 12

[Frédéric Buclin]

Committing to: bzr+ssh://[e-mail]/bugzilla/trunk/
modified collectstats.pl
modified docs/lib/Pod/Simple/HTMLBatch/Bugzilla.pm
Committed revision 7874.