Skip to content

docs(lock): clarify ILockingProvider contract and lock behavior#62369

Open
joshtrichards wants to merge 1 commit into
masterfrom
jtr/docs-lock-ILockingProvider
Open

docs(lock): clarify ILockingProvider contract and lock behavior#62369
joshtrichards wants to merge 1 commit into
masterfrom
jtr/docs-lock-ILockingProvider

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Jul 21, 2026

Copy link
Copy Markdown
Member
  • Resolves: #

Summary

Clarify the public ILockingProvider documentation to better describe its role in Nextcloud's locking architecture.

Changes

  • Clarify that the provider is a low-level primitive primarily used by storage implementations and indirectly by the Files Node and View APIs
  • Document shared and exclusive lock behavior
  • Distinguish it from the VFS-level Node/View locking APIs used during normal file operations
  • Distinguish it from the OCP\Files\Lock APIs used for user, application, and collaborative-editor file locks (i.e. via the files_app)
  • Document that it can also coordinate access to non-file server resources; for example, the encryption app uses it to prevent concurrent key-generation operations
  • Add method-level descriptions, clean up docblock parameter typing, and improve existing wording

TODO

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards joshtrichards added this to the Nextcloud 35 milestone Jul 21, 2026
@joshtrichards
joshtrichards requested a review from a team as a code owner July 21, 2026 14:51
@joshtrichards joshtrichards added enhancement 3. to review Waiting for reviews technical debt 🧱 🤔🚀 labels Jul 21, 2026
@joshtrichards
joshtrichards requested review from Altahrim, icewind1991 and salmart-dev and removed request for a team July 21, 2026 14:51
@joshtrichards
joshtrichards requested a review from come-nc July 21, 2026 14:51
@joshtrichards
joshtrichards requested a review from CarlSchwan July 21, 2026 14:53
* user, application, and collaborative-editor locks for files.
*
* @since 8.1.0
*/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

while at it you might want to add the Implementable attribute here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants