Skip to content

Commit

Permalink
Merge pull request #5088 from cgwalters/deprecate-cliwrap
Browse files Browse the repository at this point in the history
Deprecate cliwrap
  • Loading branch information
cgwalters authored Sep 13, 2024
2 parents 8001284 + 242762e commit fcfa87b
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 2 deletions.
8 changes: 7 additions & 1 deletion docs/cliwrap.md
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**.

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
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
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
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

0 comments on commit fcfa87b

Please sign in to comment.