From 6b6511d3e7c055f8e526614d73b6421218a5875e Mon Sep 17 00:00:00 2001 From: Charles Crete Date: Mon, 29 Apr 2024 02:01:18 -0400 Subject: [PATCH 1/2] docs: mention origin of obslog name --- cli/src/commands/obslog.rs | 2 ++ cli/tests/cli-reference@.md.snap | 2 ++ 2 files changed, 4 insertions(+) diff --git a/cli/src/commands/obslog.rs b/cli/src/commands/obslog.rs index c3a5e08463..c1c604db2f 100644 --- a/cli/src/commands/obslog.rs +++ b/cli/src/commands/obslog.rs @@ -31,6 +31,8 @@ use crate::ui::Ui; /// Show how a change has evolved /// /// Show how a change has evolved as it's been 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 = "@")] diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index 3574baf619..afbaaf9d60 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -1208,6 +1208,8 @@ Show how a change has evolved Show how a change has evolved as it's been updated, rebased, etc. +Name is derived from Merciual's obsolescence markers. + **Usage:** `jj obslog [OPTIONS]` ###### **Options:** From 5cf084055d428b0b7b47bff62f88e486d352cf7a Mon Sep 17 00:00:00 2001 From: Charles Crete Date: Mon, 29 Apr 2024 09:41:49 -0400 Subject: [PATCH 2/2] docs: update obslog description --- cli/src/commands/obslog.rs | 5 +++-- cli/tests/cli-reference@.md.snap | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/cli/src/commands/obslog.rs b/cli/src/commands/obslog.rs index c1c604db2f..39f65b6aa8 100644 --- a/cli/src/commands/obslog.rs +++ b/cli/src/commands/obslog.rs @@ -28,9 +28,10 @@ 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)] diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index afbaaf9d60..6e16ef6f58 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -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 @@ -1204,9 +1204,9 @@ 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.