jenkins-bot has submitted this change and it was merged. Change subject: Clarified PoolCounter::execute() docs a bit. ......................................................................
Clarified PoolCounter::execute() docs a bit. Change-Id: Id37e11e9520381cccf917d71ea269c8a85334c58 --- M includes/PoolCounter.php 1 file changed, 12 insertions(+), 2 deletions(-) Approvals: IAlex: Looks good to me, approved jenkins-bot: Verified diff --git a/includes/PoolCounter.php b/includes/PoolCounter.php index 38c6f04..2dac938 100644 --- a/includes/PoolCounter.php +++ b/includes/PoolCounter.php @@ -190,9 +190,19 @@ } /** - * Get the result of the work (whatever it is), or false. + * Get the result of the work (whatever it is), or the result of the error() function. + * This returns the result of the first applicable method that returns a non-false value, + * where the methods are checked in the following order: + * - a) doWork() : Applies if the work is exclusive or no another process + * is doing it, and on the condition that either this process + * successfully entered the pool or the pool counter is down. + * - b) doCachedWork() : Applies if the work is cacheable and this blocked on another + * process which finished the work. + * - c) fallback() : Applies for all remaining cases. + * If these all fall through (by returning false), then the result of error() is returned. + * * @param $skipcache bool - * @return bool|mixed + * @return mixed */ public function execute( $skipcache = false ) { if ( $this->cacheable && !$skipcache ) { -- To view, visit https://gerrit.wikimedia.org/r/60762 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Id37e11e9520381cccf917d71ea269c8a85334c58 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/core Gerrit-Branch: master Gerrit-Owner: Aaron Schulz <asch...@wikimedia.org> Gerrit-Reviewer: Demon <ch...@wikimedia.org> Gerrit-Reviewer: IAlex <coderev...@emsenhuber.ch> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits