From bddffde95e686b20f78403ce8817f892e6467b31 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 25 Oct 2021 19:31:47 +0000 Subject: lei p2q: document --uri, add examples This is useful for users lacking in local storage. Also, referencing lei-add-external(1) seems to make less sense than referencing lei-q(1). We'll also start dropping years from the copyright statement to reduce future churn. --- Documentation/lei-p2q.pod | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'Documentation') diff --git a/Documentation/lei-p2q.pod b/Documentation/lei-p2q.pod index 1068ff0b..2e0b1ab6 100644 --- a/Documentation/lei-p2q.pod +++ b/Documentation/lei-p2q.pod @@ -57,6 +57,10 @@ Dump output that shows the information collected for every prefix. This information can be useful for seeing how a patch is processed, but the format should not be considered stable. +=item --uri + +URI escape output for interacting with HTTP(S) public-inbox instances. + =item -q =item --quiet @@ -65,6 +69,14 @@ Suppress feedback messages. =back +=head1 EXAMPLES + + # to search for all threads which touch a given thread: + lei p2q $COMMIT_OID | lei q -t -o /tmp/results + + # to view results on a remote HTTP(S) public-inbox instance + $BROWSER https://example.com/pub-inbox/?q=$(lei p2q --uri $COMMIT_OID) + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -74,11 +86,10 @@ L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L - =head1 SEE ALSO -L +L -- cgit v1.2.3-24-ge0c7