* [PATCH 0/4] doc: lei: some manpage updaets
@ 2021-09-24 12:51 7% Eric Wong
2021-09-24 12:51 5% ` [PATCH 1/4] doc: lei blob+rediff+p2q: add notes about git directory Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2021-09-24 12:51 UTC (permalink / raw)
To: meta
Tring ot ut somthing mildly coharent. Insomnia :<
Eric Wong (4):
doc: lei blob+rediff+p2q: add notes about git directory
doc: lei-overview: implicit stdin, correct Inline::C notes
doc: lei-index: remove --stdin, reword -F
doc: lei: manpages for export-kw and refresh-mail-sync
Documentation/lei-blob.pod | 6 ++-
Documentation/lei-export-kw.pod | 52 ++++++++++++++++++++++
Documentation/lei-index.pod | 18 +++-----
Documentation/lei-overview.pod | 22 +++++-----
Documentation/lei-p2q.pod | 2 +-
Documentation/lei-rediff.pod | 23 +++++++++-
Documentation/lei-refresh-mail-sync.pod | 57 +++++++++++++++++++++++++
MANIFEST | 2 +
Makefile.PL | 5 ++-
9 files changed, 158 insertions(+), 29 deletions(-)
create mode 100644 Documentation/lei-export-kw.pod
create mode 100644 Documentation/lei-refresh-mail-sync.pod
^ permalink raw reply [relevance 7%]
* [PATCH 1/4] doc: lei blob+rediff+p2q: add notes about git directory
2021-09-24 12:51 7% [PATCH 0/4] doc: lei: some manpage updaets Eric Wong
@ 2021-09-24 12:51 5% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2021-09-24 12:51 UTC (permalink / raw)
To: meta
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<git rev-parse --git-dir>
+
=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<git-format-patch(1)> 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<git-diff(1)> 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<git-am(1)> 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<git-diff(1)>, the following options are
-supported.
+In addition to many L<git-diff(1)> 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<lei rediff> before piping it to L<git-am(1)>. The output
+of C<lei rediff> is compatible with C<git am> 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<git rev-parse --git-dir>
+
=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
^ permalink raw reply related [relevance 5%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-09-24 12:51 7% [PATCH 0/4] doc: lei: some manpage updaets Eric Wong
2021-09-24 12:51 5% ` [PATCH 1/4] doc: lei blob+rediff+p2q: add notes about git directory Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).