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

Deprecate cliwrap #5088

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Deprecate cliwrap #5088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion docs/cliwrap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@ parent: Experimental features
nav_order: 1
---

# Wrapping other CLI entrypoints
# DEPRECATED: Wrapping other CLI entrypoints

**This functionality is now deprecated and slated for removal**.
Copy link

@ipanova ipanova Sep 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

If it is known in what upcoming breaking-changes version it's going to be removed it's better to specify it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Totally agree, but I have no idea when we'll be able to do that unfortunately right now.

Given that we documented enabling cliwrap for kernel overrides today, it may be far into the future. Ideally though we'll have the kernel replacement replacement ready by the time this one actually ships in a release.


The below text documents the functionality as it exists today for historical reference.

---

A simple way to describe the goal of rpm-ostree is to convert the default model for operating system updates to be "image based".

Expand Down
3 changes: 2 additions & 1 deletion docs/treefile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ It supports the following parameters:
rpm-ostree will replace binaries such as `/usr/bin/rpm` with
wrappers that intercept unsafe operations, or adjust functionality.

The default is `false` out of conservatism; you likely want to enable this.
This is deprecated and we now plan to land relevant functionality
in the upstream projects.

* `cliwrap-binaries`: array of strings, optional. An explicit list of binaries
to enable `cliwrap`. The current allowed set contains just one value: `kernel-install`.
Expand Down
3 changes: 3 additions & 0 deletions rust/src/cliwrap.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ pub fn entrypoint(args: &[&str]) -> Result<()> {

/// Write wrappers to the target root filesystem.
fn install_to_root(args: &[&str]) -> Result<()> {
crate::client::warn_future_incompatibility(
"cliwrap is deprecated; the replacement path is to get functionality into the relevant upstream projects.",
);
let root = args
.get(0)
.map(Utf8Path::new)
Expand Down
4 changes: 4 additions & 0 deletions rust/src/treefile.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1460,6 +1460,10 @@ impl Treefile {
deprecated = true;
eprintln!("warning: initramfs-args is deprecated, use /etc/dracut.conf.d")
}
if self.get_cliwrap() {
deprecated = true;
eprintln!("warning: cliwrap is deprecated and slated for removal");
}
if deprecated {
std::thread::sleep(std::time::Duration::from_secs(3));
}
Expand Down
Loading