From fad511a6e5cf83b9d0c8404f0feec7ae3abaf45d Mon Sep 17 00:00:00 2001
From: Gabriel Scherer <gabriel.scherer@gmail.com>
Date: Wed, 20 Dec 2023 23:28:33 +0100
Subject: [PATCH] document the use of JJ_USER and JJ_EMAIL in combination with
 --reset-author

Suggested-by: David Barnett <dbarnett@google.com>
---
 cli/src/commands/describe.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/cli/src/commands/describe.rs b/cli/src/commands/describe.rs
index 2be982767..1d1ae5039 100644
--- a/cli/src/commands/describe.rs
+++ b/cli/src/commands/describe.rs
@@ -48,6 +48,11 @@ pub(crate) struct DescribeArgs {
     /// Reset the author to the configured user
     ///
     /// This resets the author name, email, and timestamp.
+    ///
+    /// You can use it in combination with the JJ_USER and JJ_EMAIL
+    /// environment variables to set a different author:
+    ///
+    /// $ JJ_USER='Foo Bar' JJ_EMAIL=foo@bar.com jj describe --reset-author
     #[arg(long)]
     reset_author: bool,
 }