From 7559defa226c950fd9ace161294b3fbcf0200e75 Mon Sep 17 00:00:00 2001 From: Eric Wong <e@80x24.org> Date: Thu, 3 Nov 2022 00:48:34 +0000 Subject: [PATCH] doc: lei: improve description of *-search commands The `OUTPUT' use may not be immediately apparent, clarify that it's from `lei q'. --- Documentation/lei-edit-search.pod | 6 ++++-- Documentation/lei-forget-search.pod | 4 +++- Documentation/lei-ls-search.pod | 5 +++-- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/Documentation/lei-edit-search.pod b/Documentation/lei-edit-search.pod index 21cb11aa..7f447ca2 100644 --- a/Documentation/lei-edit-search.pod +++ b/Documentation/lei-edit-search.pod @@ -8,7 +8,9 @@ lei edit-search [OPTIONS] OUTPUT =head1 DESCRIPTION -Invoke C<git config --edit> to edit the saved search at C<OUTPUT>. +Invoke C<git config --edit> to edit the saved search at C<OUTPUT>, +where C<OUTPUT> was supplied for argument of C<lei q -o OUTPUT ...> +A listing of outputs is available via C<lei ls-search>. =head1 CONTACT @@ -19,7 +21,7 @@ and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta =head1 COPYRIGHT -Copyright 2021 all contributors L<mailto:meta@public-inbox.org> +Copyright all contributors L<mailto:meta@public-inbox.org> License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> diff --git a/Documentation/lei-forget-search.pod b/Documentation/lei-forget-search.pod index adbe7638..5ff526f1 100644 --- a/Documentation/lei-forget-search.pod +++ b/Documentation/lei-forget-search.pod @@ -8,7 +8,9 @@ lei forget-search [OPTIONS] OUTPUT =head1 DESCRIPTION -Forget a saved search at C<OUTPUT>. +Forget a saved search at C<OUTPUT>, +where C<OUTPUT> was supplied for argument of C<lei q -o OUTPUT ...> +A listing of outputs is available via C<lei ls-search>. =head1 OPTIONS diff --git a/Documentation/lei-ls-search.pod b/Documentation/lei-ls-search.pod index a56611bf..0fe4b759 100644 --- a/Documentation/lei-ls-search.pod +++ b/Documentation/lei-ls-search.pod @@ -8,7 +8,8 @@ lei ls-search [OPTIONS] [PREFIX] =head1 DESCRIPTION -List saved search queries. If C<PREFIX> is given, restrict the output +List saved search queries (generated from C<lei q -o OUTPUT>). +If C<PREFIX> is given, restrict the output to entries that start with the specified value. =head1 OPTIONS @@ -55,7 +56,7 @@ and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta =head1 COPYRIGHT -Copyright 2021 all contributors L<mailto:meta@public-inbox.org> +Copyright all contributors L<mailto:meta@public-inbox.org> License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> -- 2.51.0