8000 The LockHandler documentation should be more clear about when the lock is released · Issue #4877 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

The LockHandler documentation should be more clear about when the lock is released #4877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
stof opened this issue Jan 18, 2015 · 0 comments
Closed

The LockHandler documentation should be more clear about when the lock is released #4877

stof opened this issue Jan 18, 2015 · 0 comments
Labels
actionable Clear and specific issues ready for anyone to take them. bug good first issue Ideal for your first contribution! (some Symfony experience may be required)

Comments

@stof
Copy link
Member
stof commented Jan 18, 2015

Currently, the doc says that the lock is released at the end of the script. But this is wrong. It can after much earlier.
The lock is released as soon as the LockHandler is garbage-collected, which happens when it goes out of scope.

See symfony/symfony#12914 for an report which is caused by this misleading documentation
@wouterj wouterj added bug good first issue Ideal for your first contribution! (some Symfony experience may be required) actionable Clear and specific issues ready for anyone to take them. labels Jan 18, 2015
@javiereguiluz javiereguiluz mentioned this issue Jan 23, 2015
Merged
weaverryan added a commit that referenced this issue Mar 13, 2015
@weaverryan
feature #4903 Reworded the explanation about when a lock is released …
325354e 
…(javiereguiluz)

This PR was merged into the 2.6 branch.

Discussion
----------

Reworded the explanation about when a lock is released

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.6+
| Fixed tickets | #4877

Commits
-------

6e14bac Fixed minor grammar issues
e632d49 Fixed the errors spotted by Wouter
89a7320 Added the new documentation inside a "caution" admonition
82a9635 Reworded the explanation about when a lock is released
4DA5 Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actionable Clear and specific issues ready for anyone to take them. bug good first issue Ideal for your first contribution! (some Symfony experience may be required)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@weaverryan @stof @wouterj
0