186866 - Add outdated custom template detection to checksetup.pl

Status: RESOLVED WONTFIX

(Bugzilla :: Installation & Upgrading, enhancement, P3)

Description

[Zach Lipton [:zach]]

It's time to finish the job I started with bug 98658. This looks for custom
templates with outdated version numbers (as compared to the default template)
and whines about them. Note that the way this patch is structured, it won't say
anything about templates missing version strings if you aren't using custom
templates, as that would be a bug in bugzilla and would be picked up on
tinderbox, no need for users to hear about it in checksetup.pl too. Patch also
adds some additional notes on the subject to the docs (docs compile untested,
but should be ok).

Comment 1

[Zach Lipton [:zach]]

Attachment: patch, v1

Comment 2

[Dave Miller [:justdave]]

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

>+    print <<END unless $silent;
...
>+The following template(s) is/are missing version tags:
>+END
>+    foreach (@missingstrings) { print "$_\n" }
>+    print "\n\n";

If you used "unless $silent" at the top, you need to on the individual prints
within that block, as well.

I'm not real sure about the docs changes either...  but it's hard to tell with
a lack of context. :)  I need to apply it and look at the result. I'm
particularly wondering about this:

>       <para>
>         If you use this method, your installation will break if CVS conflicts
>-        occur.
>+        occur. As a result, it is recomended to use the custom templates directory
>+        method, below.
>       </para>

Also, in the section where you talk about the version number in the custom
template needing to be identical, you should probably mention that they should
set the domain portion of the version number to their own domain name.

Comment 3

[Dave Miller [:justdave]]

CCing the docs people, this patch includes docs changes.

Comment 4

[Jacob Steenhagen]

In my quick browsing, it looks like this patch included some changes to the
specific areas of documentation that have been recetnly changed.  Also, the
linuxdoc standard seems to be to have a trailing / at the end of directory
names.  The proper way to do that is <filename id="directory">data</filename>,
but I don't think that actual syntax is used anywere currently :)

Comment 5

[Ralf Hauser]

When trying to follow
http://www.bugzilla.org/docs216/html/stepbystep.html#AEN679, I ran into the same
problem that checksetup.pl returned
<<Checking perl modules ...
Checking for       AppConfig (v1.52)    not found
...
Checking for     Date::Parse (any)      not found
...
Checking for      DBD::mysql (v1.2209)  not found
...
Checking for        Template (v2.07)    not found>>
while I did have a
build/AppConfig-1.55/ directory, a 
build/TimeDate-1.14, a 
build/DBD-mysql-2.1026/ (and
sources/authors/id/J/JW/JWIED/Msql-Mysql-modules-1.2219.tar.gz), and a 
build/Template-Toolkit-2.09/.

In the end, it appears that MakeMaker during
<<perl -MCPAN -e 'install "Bundle::Bugzilla"'>> assumes certain directories to
be writeable (by root?) that aren't since I am trying to install bugzilla under
a regular user id.

More details on this probable root cause for my case in
http://bugzilla.mozilla.org/show_bug.cgi?id=207039#c2

Comment 6

[Frédéric Buclin]

The trunk is now frozen to prepare Bugzilla 2.22. Only bug fixes are accepted, no enhancement bugs. As this bug has a pretty low activity (especially from the assignee), it's retargetted to ---. If you want to work on it and you think you can have it fixed for 2.24, please retarget it accordingly (to 2.24).

Comment 7

[Max Kanat-Alexander]

We don't actually use template versioning anymore, so this wouldn't be needed anymore.