Skip to content

Commit c242b2c

Browse files
committed
deprecation(rebase-snap): marked rebase-snap as deprecated
Marked `rebase-snap` as deprecated in favour of `snapshot-editor` Signed-off-by: Egor Lazarchuk <[email protected]>
1 parent d915fef commit c242b2c

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626

2727
### Deprecated
2828

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

3135
- Fixed a bug that ignored the `--show-log-origin` option, preventing it from

docs/snapshotting/snapshot-editor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This command is used to merge a `diff` snapshot memory file on
2020
top of a base memory file.
2121

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

2525
Arguments:
2626

docs/snapshotting/snapshot-support.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -249,10 +249,10 @@ created by a subsequent `/snapshot/create` API call. The order in which the
249249
snapshots were created matters and they should be merged in the same order
250250
in which they were created. To merge a `diff` snapshot memory file on
251251
top of a base, users should copy its content over the base. This can be done
252-
using the `rebase-snap` or `snapshot-editor` tools provided with the
252+
using the `rebase-snap` (deprecated) or `snapshot-editor` tools provided with the
253253
firecracker release:
254254

255-
`rebase-snap` example:
255+
`rebase-snap` (deprecated) example:
256256

257257
```bash
258258
rebase-snap --base-file path/to/base --diff-file path/to/layer

src/rebase-snap/src/main.rs

+4
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,10 @@ fn rebase(base_file: &mut File, diff_file: &mut File) -> Result<(), FileError> {
115115
}
116116

117117
fn main() -> Result<(), RebaseSnapError> {
118+
println!(
119+
"This tool is deprecated and will be removed in the future. Please use 'snapshot-editor' \
120+
instead."
121+
);
118122
let result = main_exec();
119123
if let Err(e) = result {
120124
eprintln!("{}", e);

0 commit comments

Comments
 (0)