Skip to content
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

ocibundle: confusing Create / Prepare function naming #2303

Open
dtrudg opened this issue Nov 2, 2023 · 0 comments
Open

ocibundle: confusing Create / Prepare function naming #2303

dtrudg opened this issue Nov 2, 2023 · 0 comments
Labels
techdebt

Comments

@dtrudg
Copy link
Member

dtrudg commented Nov 2, 2023

Type of issue

technical debt

Description of issue

In #2302 the tools.CreateOverlayTmpfs that creates a tmpfs, and overlay mounts it onto a rootfs, was refactored so that it calls a new tools.PrepareOverlayTmpfs which only creates the tmpfs.

The naming of these functions is confusing, but is limited by the fact that they are in the public API under pkg/

We could perhaps envisage a 3-way split of the functionality

  • tools.PrepareOverlayTmpfs
  • tools.MountOverlayTmpfs
  • tools.PrepareAndMountOverlayTmpfs

(or similar), where tools.CreateOverlayTmpfs can then be made a deprecated alias of tools.PrepareAndMountOverlayTmpfs.
@dtrudg dtrudg added the techdebt label Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
techdebt
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dtrudg