Skip to content

Fix comments and documentation - #262

Merged
derobins merged 1 commit into
developfrom
derobins/comment_docs_tweaks
Oct 19, 2026
Merged

derobins merged 1 commit into
developfrom
derobins/comment_docs_tweaks

Conversation

@derobins

Copy link
Copy Markdown
Collaborator
  • Say in hipobj.h that hipObjInit() reads the environment, so it mustn't run while another thread changes it, and that a callback must return on the thread that called it. Assert in debug builds that a thread's count of connection leases doesn't go below zero.
  • Say in hipobj.h that a staging copy that timed out keeps calls that start after it from using the buffer, rather than that the buffer can't be used, since calls already in progress aren't stopped.
  • Correct the comment in BufferMap::deregisterBuffer() about where copies of a buffer's entry are made.
  • List every package the MinIO bridge build needs in building.rst.
  • Say in interop.rst that the client's and server's MTUs must match, since hipObject doesn't negotiate a path MTU.
  • Mention the GET that sometimes hangs in the two-VM GPU lane's known-failure summary.

- Say in hipobj.h that hipObjInit() reads the environment, so it
  mustn't run while another thread changes it, and that a callback must
  return on the thread that called it. Assert in debug builds that a
  thread's count of connection leases doesn't go below zero.
- Say in hipobj.h that a staging copy that timed out keeps calls that
  start after it from using the buffer, rather than that the buffer
  can't be used, since calls already in progress aren't stopped.
- Correct the comment in BufferMap::deregisterBuffer() about where
  copies of a buffer's entry are made.
- List every package the MinIO bridge build needs in building.rst.
- Say in interop.rst that the client's and server's MTUs must match,
  since hipObject doesn't negotiate a path MTU.
- Mention the GET that sometimes hangs in the two-VM GPU lane's
  known-failure summary.

Co-Authored-By: Claude <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

Only a minor documentation correction about optional dependencies remains; no blocking issues were identified.

1 open issue
What changed in this PR

Clarifies hipObject’s caller requirements, build dependencies, and RDMA interoperability guidance, with a debug assertion for lease accounting.

Changes:

  • Clarifies threading and timed-out staging-copy behavior.
  • Documents bridge dependencies, MTU requirements, and a known CI hang.
  • Adds a lease-count assertion and corrects an ownership comment.
File Description
src/​rdma/​connection-pool.cpp Adds a debug lease-count assertion.
src/​buffer.cpp Corrects the buffer ownership comment.
include/​hipobj.h Clarifies threading and buffer-use requirements.
docs/​interop.rst Documents matching MTU requirements.
docs/​building.rst Expands MinIO bridge dependency guidance.
CHANGELOG.md Records clarified requirements and limitations.
.github/​workflows/​hipobject-hardware-test-two-vm-gpu-direct.yml Documents an intermittent GET hang.

Review effort: Balanced

Comment thread docs/building.rst
@github-actions

Copy link
Copy Markdown
Contributor
Security scan found no critical or high findings on lines changed by this pull request

View the security scan run for complete reports.

“New” means the finding is located in a changed file on an added or modified line; it is not a base-versus-head findings delta.

@derobins
derobins merged commit ca77103 into develop Oct 19, 2026
43 checks passed
@derobins
derobins deleted the derobins/comment_docs_tweaks branch October 19, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants