Skip to content

Commit 1085aba

Browse files
committed
Rename command from alloc cat to alloc log
1 parent f0a4793 commit 1085aba

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

crates/hyperqueue/src/client/commands/autoalloc.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ enum AutoAllocCommand {
3333
/// Display allocations of the specified allocation queue
3434
Info(AllocationInfoOpts),
3535
/// Display stdout/stderr of the specified allocation
36-
Cat(CatAllocationOpts),
36+
Log(LogAllocationOpts),
3737
/// Add a new allocation queue
3838
Add(AddQueueOpts),
3939
/// Pause an existing allocation queue
@@ -49,7 +49,7 @@ enum AutoAllocCommand {
4949
}
5050

5151
#[derive(Parser)]
52-
struct CatAllocationOpts {
52+
struct LogAllocationOpts {
5353
/// Allocation ID
5454
allocation: AllocationId,
5555

@@ -244,7 +244,7 @@ pub async fn command_autoalloc(
244244
AutoAllocCommand::Info(opts) => {
245245
print_allocations(gsettings, session, opts).await?;
246246
}
247-
AutoAllocCommand::Cat(opts) => {
247+
AutoAllocCommand::Log(opts) => {
248248
print_allocation_output(gsettings, session, opts).await?;
249249
}
250250
AutoAllocCommand::Remove(opts) => {
@@ -266,7 +266,7 @@ pub async fn command_autoalloc(
266266
async fn print_allocation_output(
267267
gsettings: &GlobalSettings,
268268
mut session: ClientSession,
269-
opts: CatAllocationOpts,
269+
opts: LogAllocationOpts,
270270
) -> anyhow::Result<()> {
271271
let message = FromClientMessage::AutoAlloc(AutoAllocRequest::GetAllocationInfo {
272272
allocation_id: opts.allocation,

docs/deployment/allocation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ If the allocation was submitted successfully, it will be canceled immediately to
349349
hq-submit.sh
350350
```
351351

352-
You can output the contents of the `stdout` and `stderr` files of an allocation using the [`hq alloc cat`](cli:hq.alloc.cat) command.
352+
You can output the contents of the `stdout` and `stderr` files of an allocation using the [`hq alloc log`](cli:hq.alloc.log) command.
353353

354354
## Useful autoalloc commands
355355

@@ -376,8 +376,8 @@ You can filter allocations by their state (`queued`, `running`, `finished`, `fai
376376

377377
### Display stdout/stderr output of an allocation
378378

379-
The [`hq alloc cat`](cli:hq.alloc.cat) command will print the stdout/stderr output of a specific allocation. It can be used to debug allocation errors (e.g. some PBS/Slurm problems) or the output of workers spawned in allocations.
379+
The [`hq alloc log`](cli:hq.alloc.log) command will print the stdout/stderr output of a specific allocation. It can be used to debug allocation errors (e.g. some PBS/Slurm problems) or the output of workers spawned in allocations.
380380

381381
```bash
382-
$ hq alloc cat <allocation-id> <stdout/stderr>
382+
$ hq alloc log <allocation-id> <stdout/stderr>
383383
```

0 commit comments

Comments
 (0)