276417 - Request for code change to note deprecated DB.pm routines

Status: RESOLVED WORKSFORME

(Bugzilla :: Bugzilla-General, enhancement)

Description

[Kevin Benton]

Attachment to follow.

Comment 1

[Kevin Benton]

Attachment: Patch to document deprecated routines in DB.pm

Identifies routines more clearly that are deprecated.  This will help prevent
future developers from accidentally including them in new code.  Old method was
somewhat confusing as none of the remaining routines were exported.

Comment 2

[Kevin Benton]

Comment on attachment 169860 [details] [diff] [review]
Patch to document deprecated routines in DB.pm

Removed requestee.

Comment 3

[Vlad Dascalu]

Comment on attachment 169860 [details] [diff] [review]
Patch to document deprecated routines in DB.pm

In addition to the comments, this patch also moves the deprecated DB.pm
routines at the bottom of the file.

The style of commenting might be too strong for our current commenting style,
but I guess it's ok.

I'd love an empty line before the "sub SendSQL" line here:

+##############################################################################
#
+# Deprecated routines begin here.
+##############################################################################
#
+sub SendSQL { # Deprecated

but that can be fixed upon checkin, if this passes approval.

Comment 4

[Kevin Benton]

Attachment: Version 2!

Changed comment length to 69 chars max, added blank lines as requested.

Comment 5

[Dave Miller [:justdave]]

Comment on attachment 169937 [details] [diff] [review]
Version 2!

>@@ -54,70 +63,6 @@
> # Bugzilla.pm. See bug 192531 for details.
> our $_current_sth;
> our @SQLStateStack = ();

These variable declarations and the two paragraphs of comments above them
should be moved with the deprecated routines (starting with "# All this code is
backwards compat fu."

Comment 6

[Kevin Benton]

See also: bug 276417.

Comment 7

[Kevin Benton]

Correction: See also: bug 276634 - update to Developer's Guide.

Comment 8

[Kevin Benton]

Dave - does this mean you want me to move the comment section at the top to the
deprecated routines near the bottom?

Comment 9

[Kevin Benton]

Attachment: V3 - Changes requested by Dave

While I would rather have put those comments at the top to help document the
.pm, it make sense to put all the deprecated routines at the end of the public
section along with the comments for those routines.

Comment 10

[Dave Miller [:justdave]]

any chance of getting this as a cvs diff -u (or at least a diff -u) ?

Comment 11

[Kevin Benton]

Drat -- yes, I can.  Thought I gave you diff -urN

Comment 12

[Kevin Benton]

Comment on attachment 171579 [details] [diff] [review]
V3 - Changes requested by Dave

Replacing with diff -urN

Comment 13

[Kevin Benton]

Attachment: Deprecated DB.pm update.

Comment 14

[Kevin Benton]

Comment on attachment 173678 [details] [diff] [review]
Deprecated DB.pm update.

Changed while ($result=$sth->fetchrow_array()) { to read while (my ($foo,
$bar)=$sth->fetchrow_array()) {

Comment 15

[Kevin Benton]

Attachment: Deprecated DB.pm routines update.

Comment 16

[Kevin Benton]

Dave - a friendly reminder that this is waiting on your review.

Comment 17

[Kevin Benton]

Attachment: Deprecated DB.pm routines update

Comment 18

[Max Kanat-Alexander]

This is really an enhancement, so it's 2.22 material. Also, we do already note
that they're deprecated in the POD docs, but I agree it would be good to move
them to the bottom of the file.

Comment 19

[Max Kanat-Alexander]

Comment on attachment 176145 [details] [diff] [review]
Deprecated DB.pm routines update

The information in the comments should be in POD docs instead.

The deprecated routines should not have a synopsis in the POD docs.

Comment 20

[Frédéric Buclin]

The trunk is now frozen to prepare Bugzilla 2.22. Enhancement bugs are retargetted to 2.24.

Comment 21

[Frédéric Buclin]

Deprecated DB routines do not exist anymore. This makes this bug obsolete.