file_munge_filename() doc mentions watchdog but shouldn't

allain - October 2, 2009 - 20:05
Project:Drupal
Version:6.x-dev
Component:documentation
Category:bug report
Priority:normal
Assigned:Unassigned
Status:needs review
Issue tags:Novice
Description

Documentation refers to watchdog in reference to its alerts parameter, but it's not called at all and the only other method it calls, drupal_set_message, doesn't call it either.

Maybe it should be removed?

#1

jhodgdon - October 5, 2009 - 22:32
Title:Documentation problem with file_munge_filename» file_munge_filename() doc mentions watchdog but shouldn't
Version:6.x-dev» 7.x-dev

Agreed. watchdog() is not being called, and should be removed from the doc.

Please fix in Drupal 7 first, then backport patch to Drupal 6.

#2

jhodgdon - October 8, 2009 - 18:09
Status:active» needs review

Here's some better (I think) doc for file_munge_filename().

AttachmentSizeStatusTest resultOperations
594518.patch1.54 KBIdlePassed: 13256 passes, 0 fails, 0 exceptionsView details | Re-test

#3

MichaelCole - October 18, 2009 - 17:50
Status:needs review» reviewed & tested by the community

Yes, patch applies on head.

Comment changes only. Seems thorough.

Watchdog was removed. Ship it!

Yeah! First patch review!

#4

jim0203 - October 18, 2009 - 18:03
Status:reviewed & tested by the community» needs review

Overall, a pass from me. Applies fine, solves the original problem by removing reference to watchdog(), and clarifies the rest of the documentation too. I might clarify the line which reads

If variable 'allow_insecure_uploads' evaluates to TRUE, no alterations will be made.

As it isn't immediately clear what this variable is, where it is set, etc.; but I would still pass the patch even if this line was kept as it currently is.

#5

jim0203 - October 18, 2009 - 18:05
Status:needs review» reviewed & tested by the community

Changing status to RTBC - accidentally changed away from this as we were both reviewing at the same time.

But FWIW, shouldn't patches only be set to RTBC when they've been received two positive reviews?

#6

Dries - October 18, 2009 - 18:36
Status:reviewed & tested by the community» fixed

Committed to CVS HEAD. Thanks!

#7

jhodgdon - October 19, 2009 - 15:17
Status:fixed» patch (to be ported)

Needs port to Drupal 6.

#8

jhodgdon - October 19, 2009 - 15:27
Version:7.x-dev» 6.x-dev
Status:patch (to be ported)» needs review

Here's a patch for Drupal 6.

AttachmentSizeStatusTest resultOperations
594518_D6.patch1.61 KBIgnoredNoneNone
 
 

Drupal is a registered trademark of Dries Buytaert.