X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-p2q.pod;h=4bc5d25f8ef00b9ba2591604f06f06c1ce77c44f;hb=4eee5af6011cc8cdefb66c9729952c7eff5c0b0b;hp=f404ede0cd0070ebe649dfeaca3543347dfb60c8;hpb=6b0bd44cb51112997d77721b052e4a223c62520e;p=public-inbox.git diff --git a/Documentation/lei-p2q.pod b/Documentation/lei-p2q.pod index f404ede0..4bc5d25f 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 @@ -48,7 +48,8 @@ Default: C =item --stdin -Read patch from stdin. +Read message from stdin. This is implicit if no arguments are given +and stdin is a pipe or regular file. =item --debug @@ -56,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 @@ -64,6 +69,20 @@ 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) + + # to view unapplied patches for a given $FILE from the past year: + echo \( rt:last.year.. AND dfn:$FILE \) AND NOT \( \ + $(git log -p --pretty=mboxrd --since=last.year $FILE | + lei p2q -F mboxrd ) + \) | lei q -o /tmp/unapplied + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -73,11 +92,10 @@ L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L - =head1 SEE ALSO -L +L