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.

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

Line editing layered_store #2332

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

christinerose
Copy link
Contributor

Although this file may no longer be relevant with the Tezos usage, it was in the repo, so I edited it along with the rest.

In several instances, the "pack file" is referred to rather than irmin-pack file. Should this be irmin-pack each time? Perhaps would pack file be more accurate or is just > pack file < correct?

files are the "real" object-store and suffix (those listed in the
control file), and can delete any other files it finds (which will be
control file). The main process can delete any other files it finds (which will be
the partial files the worker was creating).

If the worker process has just terminated and a crash occurs, then the
Copy link
Contributor Author

@christinerose christinerose Sep 11, 2024

Choose a reason for hiding this comment

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

Li 296 doesn't have a complete sentence. Could you clarify please?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hm there's an extra empty line 298 (which needs to be removed) but the sentence continues below. Does the following makes more sense?

If the worker process terminates just before a crash occurs, then either the current control file contains the atomically renamed control.nnnn worker's file, or it has been left untouched by the worker. If it was successfully renamed, then the main process will start operating on the new object-store and suffix file created by the worker (and will delete any residual old version of those files).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! I fixed it and (hopefully) clarified two of those sentences. Please ensure they're still accuarte.

doc/irmin-pack/design/layered_store.md Outdated Show resolved Hide resolved
files are the "real" object-store and suffix (those listed in the
control file), and can delete any other files it finds (which will be
control file). The main process can delete any other files it finds (which will be
the partial files the worker was creating).

If the worker process has just terminated and a crash occurs, then the
Copy link
Contributor

Choose a reason for hiding this comment

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

Hm there's an extra empty line 298 (which needs to be removed) but the sentence continues below. Does the following makes more sense?

If the worker process terminates just before a crash occurs, then either the current control file contains the atomically renamed control.nnnn worker's file, or it has been left untouched by the worker. If it was successfully renamed, then the main process will start operating on the new object-store and suffix file created by the worker (and will delete any residual old version of those files).

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