Skip to content

Marked rebase-snap as deprecated #4209

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@

### Deprecated

- [#4209](https://github.com/firecracker-microvm/firecracker/pull/4209):
`rebase-snap` tool is now deprecated. Users should use `snapshot-editor`
for rebasing diff snapshots.

### Fixed

- Fixed a bug that ignored the `--show-log-origin` option, preventing it from
Expand Down
2 changes: 1 addition & 1 deletion docs/snapshotting/snapshot-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This command is used to merge a `diff` snapshot memory file on
top of a base memory file.

**Note**
You can also use `rebase-snap` tool for this.
You can also use `rebase-snap` (deprecated) tool for this.

Arguments:

Expand Down
4 changes: 2 additions & 2 deletions docs/snapshotting/snapshot-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,10 +249,10 @@ created by a subsequent `/snapshot/create` API call. The order in which the
snapshots were created matters and they should be merged in the same order
in which they were created. To merge a `diff` snapshot memory file on
top of a base, users should copy its content over the base. This can be done
using the `rebase-snap` or `snapshot-editor` tools provided with the
using the `rebase-snap` (deprecated) or `snapshot-editor` tools provided with the
firecracker release:

`rebase-snap` example:
`rebase-snap` (deprecated) example:

```bash
rebase-snap --base-file path/to/base --diff-file path/to/layer
Expand Down
4 changes: 4 additions & 0 deletions src/rebase-snap/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ fn rebase(base_file: &mut File, diff_file: &mut File) -> Result<(), FileError> {
}

fn main() -> Result<(), RebaseSnapError> {
println!(
"This tool is deprecated and will be removed in the future. Please use 'snapshot-editor' \
instead."
);
let result = main_exec();
if let Err(e) = result {
eprintln!("{}", e);
Expand Down