From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 954721F934 for ; Fri, 24 Sep 2021 12:51:09 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 1/4] doc: lei blob+rediff+p2q: add notes about git directory Date: Fri, 24 Sep 2021 12:51:06 +0000 Message-Id: <20210924125109.23456-2-e@80x24.org> In-Reply-To: <20210924125109.23456-1-e@80x24.org> References: <20210924125109.23456-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: Try to clarify these commands are intended to be useful for git-using (usually software) projects (and not the bare git repos we use internally). We'll also document some commonly useful git-diff switches in the lei-rediff man page to highlight the usefulness of the command. --- Documentation/lei-blob.pod | 6 ++++-- Documentation/lei-p2q.pod | 2 +- Documentation/lei-rediff.pod | 23 +++++++++++++++++++++-- 3 files changed, 26 insertions(+), 5 deletions(-) diff --git a/Documentation/lei-blob.pod b/Documentation/lei-blob.pod index 5b611d11ba1f..429d206e358e 100644 --- a/Documentation/lei-blob.pod +++ b/Documentation/lei-blob.pod @@ -10,8 +10,8 @@ lei blob [OPTIONS] OID Display a git blob. The blob may correspond to a message from the local store, an existing blob in the current repository, or a -not-yet-created blob in the current repository that can be -reconstructed from a message. +not-yet-created blob in the current git project repository (if any) +that can be reconstructed from a message. =head1 OPTIONS @@ -22,6 +22,8 @@ reconstructed from a message. Specify an additional .git/ directory to scan. This option may be given multiple times. +Default: the output of C + =item --no-cwd Do not look in the git repository of the current working directory. diff --git a/Documentation/lei-p2q.pod b/Documentation/lei-p2q.pod index 44798ac3d2a0..1068ff0beb27 100644 --- a/Documentation/lei-p2q.pod +++ b/Documentation/lei-p2q.pod @@ -16,7 +16,7 @@ inbox. The patch can be provided on stdin or as a file. Alternatively, when an argument is given that does not point to an existing file, it is -taken as a reference to a commit in the current repository, and +taken as a reference to a commit in the current git repository, and L is used to generate the patch. =head1 OPTIONS diff --git a/Documentation/lei-rediff.pod b/Documentation/lei-rediff.pod index c7db6c1e20b6..f34e946ffe52 100644 --- a/Documentation/lei-rediff.pod +++ b/Documentation/lei-rediff.pod @@ -15,10 +15,15 @@ the specified L options. This is useful if you want to change the display of the original patch (e.g., increasing context, coloring moved lines differently, or using an external diff viewer). +It relies on the contents of the .git directory of your current +project working tree. In other words, it works anywhere +L works. Otherwise, C<--git-dir=> may be specified +any number of times to add repositories to build blob data from. + =head1 OPTIONS -In addition to many L, the following options are -supported. +In addition to many L options (e.g. C<-W>, C<-w>, +C<-U $LINES>) the following options are supported: =over @@ -27,15 +32,29 @@ supported. Read message from stdin. This is implicit if no arguments are given and stdin is a pipe or regular file. +For users of text editors and pagers capable of piping its +buffer to arbitrary commands, it is useful to pipe a patch email +to C before piping it to L. The output +of C is compatible with C if its input was a +patch email. + =item --git-dir=DIR Specify an additional .git/ directory to scan. This option may be given multiple times. +Default: the output of C + =item --no-cwd Do not look in the git repository of the current working directory. +=item -q + +=item --quiet + +Suppress progress output. + =item -v =item --verbose