Lock Checker: document why @SideEffectsOnly is not a SideEffectAnnotation

[mernst]

@SideEffectsOnly constrains which expressions a method modifies, but it promises nothing about acquiring or releasing locks, so a @SideEffectsOnly method gets the same locking guarantee as an unannotated one.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: bf168827-e220-407b-bce4-2eb1cb0d1158

📥 Commits

Reviewing files that changed from the base of the PR and between f304841 and 186512f.

📒 Files selected for processing (2)

• checker/src/main/java/org/checkerframework/checker/lock/LockAnnotatedTypeFactory.java
• checker/tests/lock/SideEffectsOnlyLock.java

---

📝 Walkthrough

Walkthrough

The lock checker documentation now states that @SideEffectsOnly provides no lock acquisition or release guarantee. A new test verifies this behavior with annotated calls and a synchronized field-mutating method.

Possibly related PRs

• typetools/checker-framework#7962: Modifies the same lock-checker file and adds the same regression test.
• typetools/checker-framework#7818: Introduces related @SideEffectsOnly lock-checker behavior and tests.
• typetools/checker-framework#7952: Introduces the @SideEffectsOnly behavior that this change documents and tests.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}