Closed Bug 147776 Opened 22 years ago Closed 15 years ago

checksetup.pl should re-write localconfig with the current comments

Categories

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

2.17
enhancement

Tracking

()

RESOLVED FIXED
Bugzilla 3.4

People

(Reporter: justdave, Assigned: mkanat)

References

Details

(Whiteboard: [relnote comment 8])

Attachments

(1 file, 2 obsolete files)

As discussed in bug 143108, we sometimes slightly change the definition of a
variable in localconfig.  Our current mechanism of writing variables to
localconfig doesn't allow us to change the comments on a variable that's already
in localconfig.  Changing the default comment only changes the comment on a
config that hasn't picked up that variable yet.

The best way to do this is to read in the file, add any defaults that are
missing, in memory, then re-write the entire file out with all of the default
comments (instead of just appending the new ones to the end).  Need to make sure
it's documented at the top of the file that changes to comments will be lost.

Maybe we can provide a way to add comments that won't get lost...

This would also allow us to put them in a specific order in the file, so they
can be grouped by function, even if new ones are added later.
The options and comments should be in a hash, so that when we ask them in
checksetup.pl later we can use the comment as a prompt.
Target Milestone: --- → Bugzilla 2.18
This is something to address for newinstall
Depends on: 105854
Unloved bugs targetted for 2.18 but untouched since 9-15-2003 are being
retargeted to 2.20
If you plan to act on one immediately, go ahead and pull it back to 2.18.
Target Milestone: Bugzilla 2.18 → Bugzilla 2.20
This bug has not been touched by its owner in over six months, even though it is
targeted to 2.20, for which the freeze is 10 days away. Unsetting the target
milestone, on the assumption that nobody is actually working on it or has any
plans to soon.

If you are the owner, and you plan to work on the bug, please give it a real
target milestone. If you are the owner, and you do *not* plan to work on it,
please reassign it to nobody@bugzilla.org or a .bugs component owner. If you are
*anybody*, and you get this comment, and *you* plan to work on the bug, please
reassign it to yourself if you have the ability.
Target Milestone: Bugzilla 2.20 → ---
QA Contact: mattyt-bugzilla → default-qa
I could have done this pretty easily when re-writing the localconfig-generation code, but I didn't, because it would destroy people's local customizations.

So we have to have a way to also move un-kept localconfig varibles into another file, just like we do with old-params.txt.
Assignee: zach → mkanat
Severity: normal → enhancement
Blocks: 123165
Attached patch v1 (obsolete) — Splinter Review
Okay, this does it. Tested locally. Granting myself review as module owner.
Attachment #297594 - Flags: review+
Checking in Bugzilla/Install/Filesystem.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Filesystem.pm,v  <--  Filesystem.pm
new revision: 1.26; previous revision: 1.25
done
Checking in Bugzilla/Install/Localconfig.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Localconfig.pm,v  <--  Localconfig.pm
new revision: 1.11; previous revision: 1.10
done
Status: NEW → RESOLVED
Closed: 16 years ago
Flags: approval+
Keywords: relnote
Resolution: --- → FIXED
Target Milestone: --- → Bugzilla 3.2
Oh, and anybody writing relnotes should note that this now moves any unexpected localconfig vars into a file called localconfig.old, much like old-params.txt.
Whiteboard: [relnote comment 8]
I backed out this patch. checksetup.pl throws some cryptic message, using Perl 5.8.8:

Reading ./localconfig...

The following variables are no longer used in ./localconfig, and
have been moved to ./localconfig.old: _<./localconfig

and localconfig.log contains nothing useful:

$_<./localconfig = './localconfig';



Checking in Bugzilla/Install/Filesystem.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Filesystem.pm,v  <--  Filesystem.pm
new revision: 1.27; previous revision: 1.26
done
Checking in Bugzilla/Install/Localconfig.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Localconfig.pm,v  <--  Localconfig.pm
new revision: 1.12; previous revision: 1.11
done
Status: RESOLVED → REOPENED
Flags: approval+
Resolution: FIXED → ---
I tested here on perl 5.8.5 and I can't reproduce your issue. Could you attach your localconfig (with a blank $db_pass, of course)?
I mean, I tested on perl 5.8.8. :-)
Status: REOPENED → ASSIGNED
Priority: -- → P2
Bugzilla 3.2 is now frozen. Only enhancements blocking 3.2 or specifically approved for 3.2 may be checked in to the 3.2 branch. If you would like to nominate your enhancement for Bugzilla 3.2, set "blocking3.2" tp "?", and either the target milestone will be changed back, or the blocking3.2 flag will be granted, if we will accept this enhancement for Bugzilla 3.2.
Target Milestone: Bugzilla 3.2 → Bugzilla 4.0
Frederic, could you attach that localconfig file that causes the bug?
Flags: needsinfo?(LpSolit)
Attached file my localconfig file (obsolete) —
Here is the localconfig file I'm using. Remove the file extension for use with Bugzilla.
Flags: needsinfo?(LpSolit)
Attached patch v2Splinter Review
Okay, I implemented a solution that will solve any future problem like that wholesale--we only accept symbols that begin with a letter or a number.

Granting myself review as module owner.
Attachment #297594 - Attachment is obsolete: true
Attachment #331087 - Attachment is obsolete: true
Attachment #355287 - Flags: review+
Comment on attachment 355287 [details] [diff] [review]
v2

>Index: Bugzilla/Install/Filesystem.pm

>+        "$localconfig.old" => { perms => $owner_readable },

Do you really mean $localconfig.old? Or localconfig.old?
I really mean $localconfig.old, yes. That's the full path to the file.

I fixed the POD of Bugzilla::Install::Localconfig on checkin, there was a slight error.

Checking in Bugzilla/Install/Filesystem.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Filesystem.pm,v  <--  Filesystem.pm
new revision: 1.33; previous revision: 1.32
done
Checking in Bugzilla/Install/Localconfig.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Localconfig.pm,v  <--  Localconfig.pm
new revision: 1.13; previous revision: 1.12
done
Status: ASSIGNED → RESOLVED
Closed: 16 years ago15 years ago
Resolution: --- → FIXED
Target Milestone: Bugzilla 4.0 → Bugzilla 3.4
Added to the release notes for Bugzilla 3.4 in bug 494037.
Keywords: relnote
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: