docs: remove mentions of command-group

This commit is contained in:
Félix Saparelli 2024-10-14 12:10:45 +13:00
parent 71aa35a095
commit 967d53dfc0
No known key found for this signature in database
8 changed files with 13 additions and 41 deletions

24
Cargo.lock generated
View file

@ -699,18 +699,6 @@ version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d3fd119d74b830634cea2a0f58bbd0d54540518a14397557951e79340abc28c0"
[[package]]
name = "command-group"
version = "2.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5080df6b0f0ecb76cab30808f00d937ba725cebe266a3da8cd89dff92f2a9916"
dependencies = [
"async-trait",
"nix 0.26.4",
"tokio",
"winapi",
]
[[package]]
name = "concurrent-queue"
version = "2.5.0"
@ -2466,17 +2454,6 @@ dependencies = [
"smallvec",
]
[[package]]
name = "nix"
version = "0.26.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "598beaf3cc6fdd9a5dfb1630c2800c7acd31df7aaf0f565796fba2b53ca1af1b"
dependencies = [
"bitflags 1.3.2",
"cfg-if",
"libc",
]
[[package]]
name = "nix"
version = "0.27.1"
@ -4120,7 +4097,6 @@ dependencies = [
"clap_complete_nushell",
"clap_mangen",
"clearscreen",
"command-group",
"console-subscriber",
"dashmap",
"dirs 5.0.1",

View file

@ -52,10 +52,6 @@ which = "6.0.1"
version = "1.3.3"
features = ["rayon"]
[dependencies.command-group]
version = "2.1.0"
features = ["with-tokio"]
[dependencies.clap]
version = "4.4.7"
features = ["cargo", "derive", "env", "wrap_help"]

View file

@ -42,7 +42,7 @@
//! ```
//!
//! Alternatively, you can use the modules exposed by the crate and the external crates such as
//! [`ClearScreen`][clearscreen] and [Command Group][command_group] to build something more advanced,
//! [`ClearScreen`][clearscreen] and [Process Wrap][process_wrap] to build something more advanced,
//! at the cost of reimplementing the glue code.
//!
//! Note that the library generates a _lot_ of debug messaging with [tracing]. **You should not

View file

@ -55,7 +55,7 @@ pub struct SpawnOptions {
/// Run the program in a new process group.
///
/// This will use either of Unix [process groups] or Windows [Job Objects] via the
/// [`command-group`](command_group) crate.
/// [`process-wrap`](process_wrap) crate.
///
/// [process groups]: https://en.wikipedia.org/wiki/Process_group
/// [Job Objects]: https://en.wikipedia.org/wiki/Object_Manager_(Windows)

View file

@ -215,9 +215,9 @@ impl Job {
/// the _previous_ run of the command.
///
/// Technically, some operations can be done through a `&self` shared borrow on the running
/// command's [`ErasedChild`](command_group::tokio::ErasedChild), but this library recommends
/// against taking advantage of this, and prefer using the methods here instead, so that the
/// supervisor can keep track of what's going on.
/// command's [`TokioChildWrapper`], but this library recommends against taking advantage of this,
/// and prefer using the methods on here instead, so that the supervisor can keep track of
/// what's going on.
pub fn run(&self, fun: impl FnOnce(&JobTaskContext<'_>) + Send + Sync + 'static) -> Ticket {
self.control(Control::SyncFunc(Box::new(fun)))
}
@ -229,9 +229,9 @@ impl Job {
/// the _previous_ run of the command.
///
/// Technically, some operations can be done through a `&self` shared borrow on the running
/// command's [`ErasedChild`](command_group::tokio::ErasedChild), but this library recommends
/// against taking advantage of this, and prefer using the methods here instead, so that the
/// supervisor can keep track of what's going on.
/// command's [`TokioChildWrapper`], but this library recommends against taking advantage of this,
/// and prefer using the methods on here instead, so that the supervisor can keep track of
/// what's going on.
///
/// A gotcha when using this method is that the future returned by the function can live longer
/// than the `&JobTaskContext` it was given, so you can't bring the context into the async block

View file

@ -12,9 +12,9 @@ use crate::command::Command;
/// of the command, and can be queried via the [`JobTaskContext`](super::JobTaskContext) by hooks.
///
/// Technically, some operations can be done through a `&self` shared borrow on the running
/// command's [`ErasedChild`](command_group::tokio::ErasedChild), but this library recommends
/// against taking advantage of this, and prefer using the methods on [`Job`](super::Job) instead,
/// so that the job can keep track of what's going on.
/// command's [`TokioChildWrapper`], but this library recommends against taking advantage of this,
/// and prefer using the methods on [`Job`](super::Job) instead, so that the job can keep track of
/// what's going on.
#[derive(Debug)]
#[cfg_attr(test, derive(Clone))]
pub enum CommandState {

View file

@ -12,7 +12,7 @@ use watchexec_events::ProcessEnd;
use crate::command::{Command, Program};
/// Mock version of [`ErasedChild`](command_group::ErasedChild).
/// Mock version of [`TokioChildWrapper`](process_wrap::tokio::TokioChildWrapper).
#[derive(Debug, Clone)]
pub struct TestChild {
pub grouped: bool,

View file

@ -23,7 +23,7 @@
//! task is spawned on the Tokio runtime, and so runs in the background. A `Job` takes as input a
//! [`Command`](command::Command), which describes how to start a single process, through either a
//! shell command or a direct executable invocation, and if the process should be grouped (using
//! [`command-group`](command_group)) or not.
//! [`process-wrap`](process_wrap)) or not.
//!
//! The job's task runs an event loop on two sources: the process's `wait()` (i.e. when the process
//! ends) and the job's control queue. The control queue is a hybrid MPSC queue, with three priority