Skip to content

docs(design): document loop autoclear for block bind mounts - #872

Draft
Vi-shub wants to merge 1 commit into
urunc-dev:mainfrom
Vi-shub:docs/loop-autoclear-storage
Draft

docs(design): document loop autoclear for block bind mounts#872
Vi-shub wants to merge 1 commit into
urunc-dev:mainfrom
Vi-shub:docs/loop-autoclear-storage

Conversation

@Vi-shub

@Vi-shub Vi-shub commented Jul 31, 2026

Copy link
Copy Markdown

Description

As diving more in the codebase I observe this TODO and critical part to be documented.
Documents the loop-device autoclear behavior used when urunc turns host bind mounts into guest block devices.
This addresses the TODO in pkg/unikontainers/block.go that asked for storage-handling documentation covering:

  • why autoclear is cleared before unmount
  • that delete restores autoclear / remounts when possible
  • the caveat if delete never runs
    Also adds a short link from the design overview and replaces the long inline TODO with a pointer to the new page.

Related issues

Fixes #873 and comment that contributors.yaml is now a clean 3-line add (LF).

How was this tested?

  • Reviewed the new page against getBlockVolumes / restoreBlockVolumes in pkg/unikontainers/block.go
  • Confirmed docs/design/*.md is already included in mkdocs.yml nav

LLM usage

Claude Code assisted with drafting the documentation; I reviewed it for accuracy against the code.

Checklist

  • I have read the contribution guide.
  • The linter passes locally (make lint).
  • The e2e tests of at least one tool pass locally (make test_ctr, make test_nerdctl, make test_docker, make test_crictl).
  • If LLMs were used: I have read the llm policy.

@cmainas - please take a look when you have a moment. Thanks for your time 😄

@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for urunc ready!

Name Link
🔨 Latest commit c58c94b
🔍 Latest deploy log https://app.netlify.com/projects/urunc/deploys/6a6cf8c448a21300086b4d19
😎 Deploy Preview https://deploy-preview-872--urunc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@cmainas cmainas added invalid This doesn't seem right do-not-merge labels Jul 31, 2026
Explain why urunc clears loop autoclear before unmounting eligible
bind mounts, and that delete restores it. Remove the inline TODO.

Signed-off-by: Vi-shub <smsharma3121@gmail.com>
@Vi-shub
Vi-shub force-pushed the docs/loop-autoclear-storage branch from 12dcdd9 to c58c94b Compare July 31, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge invalid This doesn't seem right

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document loop autoclear behavior for block bind mounts

2 participants