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

docs: update obslog description and mention origin of name #3593

Merged
merged 2 commits into from
May 3, 2024
Merged

docs: update obslog description and mention origin of name #3593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b6511d
docs: mention origin of obslog name
Cretezy Apr 29, 2024
5cf0840
docs: update obslog description
Cretezy Apr 29, 2024
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
7 changes: 5 additions & 2 deletions cli/src/commands/obslog.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@ use crate::formatter::Formatter;
use crate::graphlog::{get_graphlog, Edge};
use crate::ui::Ui;

/// Show how a change has evolved
/// Show how a change has evolved over time
///
/// Show how a change has evolved as it's been updated, rebased, etc.
/// Lists the previous commits which a change has pointed to. The current commit
/// of a change evolves when the change is updated, rebased, etc.
///
/// Name is derived from Merciual's obsolescence markers.
#[derive(clap::Args, Clone, Debug)]
pub(crate) struct ObslogArgs {
#[arg(long, short, default_value = "@")]
Expand Down
8 changes: 5 additions & 3 deletions cli/tests/[email protected]
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ To get started, see the tutorial at https://github.com/martinvonz/jj/blob/main/d
* `move` — Move changes from one revision into another
* `new` — Create a new, empty change and (by default) edit it in the working copy
* `next` — Move the working-copy commit to the child revision
* `obslog` — Show how a change has evolved
* `obslog` — Show how a change has evolved over time
* `operation` — Commands for working with the operation log
* `parallelize` — Parallelize revisions by making them siblings
* `prev` — Change the working copy revision relative to the parent revision
Expand Down Expand Up @@ -1204,9 +1204,11 @@ implied.

## `jj obslog`

Show how a change has evolved
Show how a change has evolved over time

Show how a change has evolved as it's been updated, rebased, etc.
Lists the previous commits which a change has pointed to. The current commit of a change evolves when the change is updated, rebased, etc.

Name is derived from Merciual's obsolescence markers.

**Usage:** `jj obslog [OPTIONS]`

Expand Down