summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRory Dudley2024-05-20 14:11:48 -0600
committerRory Dudley2024-05-20 14:11:48 -0600
commit2d4f347d217e31d6685d52eca1657a5020e92c56 (patch)
treead2b8d8f13091af50a768ca799ff221dc0026ba4
parent6f7b03981ae2c9b79c8d6125e1998bcc67f59fc2 (diff)
downloaddwarvish-2d4f347d217e31d6685d52eca1657a5020e92c56.tar.gz
Update doc comments for Runes
Added documentation comments for the new Runes that help with handling file redirection of STDERR.
-rw-r--r--src/poem/elements/rune.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/poem/elements/rune.rs b/src/poem/elements/rune.rs
index 1322ca5..688043d 100644
--- a/src/poem/elements/rune.rs
+++ b/src/poem/elements/rune.rs
@@ -21,7 +21,11 @@ use core::fmt;
/// * `Poem` - A subcommand to run first (`\``)
/// * `Read` - Read files into STDIN (`<`)
/// * `Write` - Write STDOUT to a file (`>`)
+/// * `Write2` - Write STDERR to a file (`2>`)
+/// * `WriteAll` - Write both STDOUT and STDERR to a file (`&>`)
/// * `Addendum` - Append STDOUT to a file (`>>`)
+/// * `Addendum2` - Append STDERR to a file (`2>>`)
+/// * `AddendumAll` - Append both STDOUT and STDERR to a file (`&>>`)
/// * `Couplet` - Pipe the output of this command into the next (`|`)
/// * `Quiet` - Fork the called process into the background (`&`)
/// * `And` - Run the next command only if this one succeeds (`&&`)