Documentation:

Return value

bool
TRUE if the wait operation was successful and lock may be available. You
still need to acquire the lock manually and it may fail again.

Implementation:

...
    if ($this->lockMayBeAvailable($name)) {
      // No longer need to wait.
      return FALSE;
    }
  }
  // The caller must still wait longer to get the lock.
  return TRUE;
}
Files: 
CommentFileSizeAuthor
#4 drupal-2057131-4.patch723 bytesolli
PASSED: [[SimpleTest]]: [MySQL] 57,992 pass(es).
[ View ]
#1 drupal-2057131-1.patch666 bytesolli
PASSED: [[SimpleTest]]: [MySQL] 57,588 pass(es).
[ View ]

Comments

Status:Active» Needs review
StatusFileSize
new666 bytes
PASSED: [[SimpleTest]]: [MySQL] 57,588 pass(es).
[ View ]

Status:Needs review» Needs work
Issue tags:-documentation

The last submitted patch, drupal-2057131-1.patch, failed testing.

Status:Needs work» Needs review
Issue tags:+documentation

#1: drupal-2057131-1.patch queued for re-testing.

That was "Last checked is updated" in Drupal\locale\Tests\LocaleUpdateCronTest->testUpdateCron() line 120.

Component:lock system» documentation
StatusFileSize
new723 bytes
PASSED: [[SimpleTest]]: [MySQL] 57,992 pass(es).
[ View ]

Maybe this? In D7 it says "TRUE if the lock holds, FALSE if it is available".

Component:documentation» lock system
Status:Needs review» Reviewed & tested by the community

I agree with this documentation change, which as you say, appears to fit with the actual implementation in the class. Let's move it to the Lock System again and see if the maintainers agree with the change to the interface documentation.

Component:lock system» documentation
Status:Reviewed & tested by the community» Fixed

No comment from the maintainers. I went ahead and committed this documentation change. Thanks again!

Automatically closed -- issue fixed for 2 weeks with no activity.

Issue summary:View changes

Updated issue summary.