r101750 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r101749‎ | r101750 | r101751 >
Date:23:29, 2 November 2011
Author:krinkle
Status:ok
Tags:
Comment:
[JSTesting] fix function documentation
* Follows-up r101744
Modified paths:
  • /trunk/tools/testswarm/scripts/testswarm-mw-fetcher.php (modified) (history)

Diff [purge]

Index: trunk/tools/testswarm/scripts/testswarm-mw-fetcher.php
@@ -118,7 +118,7 @@
119119 }
120120
121121 /**
122 - * Try to fetch the next revision (relative latest checkout in the checkouts directory).
 122+ * Try to fetch the next revision (relative to the latest checkout in the checkouts directory).
123123 * This is the main entry point after construction.
124124 */
125125 public function tryFetchNextRev() {
@@ -312,9 +312,9 @@
313313 /** LOGGING **/
314314
315315 /**
316 - * Utility function to log a message for a given id.
 316+ * Utility function to save a message to the log file.
317317 *
318 - * @param $msg string: message to log. Will be prefixed with date("c")
 318+ * @param $msg string: message to log. Will be prefixed with a timestamp.
319319 * @param $callee string: Callee function to be logged as origin.
320320 */
321321 public function log( $msg, $callee = '', $prefix = '' ) {
@@ -330,10 +330,13 @@
331331 }
332332
333333 /**
334 - * Log a debug message. Only logged in debug mode.
 334+ * Echo a debug message directly to the output. Ignored when not in debug mode.
335335 * Messages are prefixed with "DEBUG> ".
336336 * Multiline messages will be split up.
337337 *
 338+ * In contrary to log(), these are not saved in a file (you can save them if needed,
 339+ * simply point output to a file from the shell; $ php foo.php > debug.log).
 340+ *
338341 * @param $msg string: Message to print.
339342 * @param $callee string.
340343 */

Past revisions this follows-up on

RevisionCommit summaryAuthorDate
r101744[JSTesting] partial rewrite of TestSwarmMWFetcher...krinkle23:17, 2 November 2011

Status & tagging log