aboutsummaryrefslogtreecommitdiffstats
path: root/man/b4.5
blob: 611608fa789961e8a16d49495670a37a3ef6e6f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "B4" 5 "2023-01-19" "0.12.0" ""
.SH NAME
B4 \- Work with code submissions in a public-inbox archive
.SH SYNOPSIS
.sp
b4 {mbox,am,shazam,pr,diff,ty,kr,prep,send,trailers} [options]
.SH DESCRIPTION
.sp
This is a helper utility to work with patches and pull requests made
available via a public\-inbox archive like lore.kernel.org. It is
written to make it easier to participate in a patch\-based workflows,
like those used in the Linux kernel development.
.sp
The name \(dqb4\(dq was chosen for ease of typing and because B\-4 was the
precursor to Lore and Data in the Star Trek universe.
.sp
Full documentation is available on \fI\%https://b4.docs.kernel.org/\fP\&.
.SH SUBCOMMANDS
.sp
Maintainer\-oriented:
.INDENT 0.0
.IP \(bu 2
\fImbox\fP: Download a thread as an mbox file
.IP \(bu 2
\fIam\fP: Create an mbox file that is ready to git\-am
.IP \(bu 2
\fIshazam\fP: Apply patch series to git repositories
.IP \(bu 2
\fIpr\fP: Work with pull requests
.IP \(bu 2
\fIdiff\fP: Show range\-diff style diffs between patch versions
.IP \(bu 2
\fIty\fP: Create templated replies for processed patches and pull requests
.IP \(bu 2
\fIkr\fP: (EXPERIMENTAL) Operate on patatt\-compatible keyrings
.UNINDENT
.sp
Contributor\-oriented:
.INDENT 0.0
.IP \(bu 2
\fIprep\fP: (EXPERIMENTAL) prepare your series for submission
.IP \(bu 2
\fIsend\fP: (EXPERIMENTAL) send your series for review on distribution lists
.IP \(bu 2
\fItrailers\fP: (EXPERIMENTAL) retrieve and apply code\-review trailers
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.B  \-d\fP,\fB  \-\-debug
Add more debugging info to the output (default: False)
.TP
.B  \-q\fP,\fB  \-\-quiet
Output critical information only (default: False)
.TP
.B  \-n\fP,\fB  \-\-no\-interactive
Do not ask any interactive questions (default: False)
.TP
.B  \-\-offline\-mode
Do not perform any network queries (default: False)
.TP
.B  \-\-no\-stdin
Disable TTY detection for stdin (default: False)
.UNINDENT
.SH SUBCOMMAND OPTIONS
.SS b4 mbox
.sp
This command allows retrieving entire threads from a remote public\-inbox
instance. The resulting mbox file can then be opened with most MUA
clients for actions like replying to conversations or reviewing patch
submissions.
.INDENT 0.0
.TP
.B usage:
b4 mbox [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-o OUTDIR] [\-c] [\-n WANTNAME] [\-M] [\-f] [msgid]
.TP
.B positional arguments:
msgid                 Message ID to process, or pipe a raw message
.TP
.B options:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
Use a specific project instead of default (linux\-mm, linux\-hardening, etc)
.TP
.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
.TP
.BI \-\-stdin\-pipe\-sep \ STDIN_PIPE_SEP
When accepting messages on stdin, split using this pipe separator string
.TP
.B  \-C\fP,\fB  \-\-no\-cache
Do not use local cache
.TP
.BI \-o \ OUTDIR\fR,\fB \ \-\-outdir \ OUTDIR
Output into this directory (or use \- to output mailbox contents to stdout)
.TP
.B  \-c\fP,\fB  \-\-check\-newer\-revisions
Check if newer patch revisions exist
.TP
.BI \-n \ WANTNAME\fR,\fB \ \-\-mbox\-name \ WANTNAME
Filename to name the mbox destination
.TP
.B  \-M\fP,\fB  \-\-save\-as\-maildir
Save as maildir (avoids mbox format ambiguities)
.TP
.B  \-f\fP,\fB  \-\-filter\-dupes
When adding messages to existing maildir, filter out duplicates
.TP
.BI \-r \ MBOX\fR,\fB \ \-\-refetch \ MBOX
Refetch all messages in specified mbox with their original headers
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 mbox \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
.SS b4 am
.sp
This command allows retrieving threads from a public\-inbox instance and
preparing them for applying to a git repository using the \(dqgit am\(dq
command. It will automatically perform the following operations:
.INDENT 0.0
.IP \(bu 2
pick the latest submitted version of the series (it can check for
newer threads using \fB\-c\fP as well)
.IP \(bu 2
check DKIM signatures and patatt attestation on all patches and code
review messages
.IP \(bu 2
collate all submitted code\-review trailers (Reviewed\-by, Acked\-by,
etc) and put them into the commit message
.IP \(bu 2
add your own Signed\-off\-by trailer (with \fB\-s\fP)
.IP \(bu 2
reroll series from partial updates (e.g. someone submits a v2 of a
single patch instead of rerolling the entire series)
.IP \(bu 2
guess where in the tree history the patches belong, if the exact
commit\-base is not specified (with \fB\-g\fP)
.IP \(bu 2
prepare the tree for a 3\-way merge (with \fB\-3\fP)
.IP \(bu 2
cherry\-pick a subset of patches from a large series (with \fB\-P\fP)
.UNINDENT
.INDENT 0.0
.TP
.B usage:
b4 am [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-o OUTDIR] [\-c] [\-n WANTNAME] [\-M] [\-v WANTVER] [\-t] [\-S] [\-T] [\-s] [\-l] [\-P CHERRYPICK] [\-\-cc\-trailers] [\-\-no\-parent] [\-\-allow\-unicode\-control\-chars] [\-Q] [\-g] [\-b GUESSBRANCH [GUESSBRANCH ...]] [\-\-guess\-lookback GUESSDAYS] [\-3] [\-\-no\-cover] [\-\-no\-partial\-reroll] [msgid]
.TP
.B positional arguments:
msgid                 Message ID to process, or pipe a raw message
.TP
.B options:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
Use a specific project instead of default (linux\-mm, linux\-hardening, etc)
.TP
.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
.TP
.BI \-\-stdin\-pipe\-sep \ STDIN_PIPE_SEP
When accepting messages on stdin, split using this pipe separator string
.TP
.B  \-C\fP,\fB  \-\-no\-cache
Do not use local cache
.TP
.BI \-o \ OUTDIR\fR,\fB \ \-\-outdir \ OUTDIR
Output into this directory (or use \- to output mailbox contents to stdout)
.TP
.B  \-c\fP,\fB  \-\-check\-newer\-revisions
Check if newer patch revisions exist
.TP
.BI \-n \ WANTNAME\fR,\fB \ \-\-mbox\-name \ WANTNAME
Filename to name the mbox destination
.TP
.B  \-M\fP,\fB  \-\-save\-as\-maildir
Save as maildir (avoids mbox format ambiguities)
.TP
.BI \-v \ WANTVER\fR,\fB \ \-\-use\-version \ WANTVER
Get a specific version of the patch/series
.TP
.B  \-t\fP,\fB  \-\-apply\-cover\-trailers
Apply trailers sent to the cover letter to all patches
.TP
.B  \-S\fP,\fB  \-\-sloppy\-trailers
Apply trailers without email address match checking
.TP
.B  \-T\fP,\fB  \-\-no\-add\-trailers
Do not add or sort any trailers
.TP
.B  \-s\fP,\fB  \-\-add\-my\-sob
Add your own signed\-off\-by to every patch
.TP
.B  \-l\fP,\fB  \-\-add\-link
Add a Link: with message\-id lookup URL to every patch
.TP
.BI \-P \ CHERRYPICK\fR,\fB \ \-\-cherry\-pick \ CHERRYPICK
Cherry\-pick a subset of patches (e.g. \(dq\-P 1\-2,4,6\-\(dq, \(dq\-P _\(dq to use just the msgid specified, or \(dq\-P \fIglobbing\fP\(dq to match on commit subject)
.TP
.B  \-\-cc\-trailers
Copy all Cc\(aqd addresses into Cc: trailers
.TP
.B  \-\-no\-parent
Break thread at the msgid specified and ignore any parent messages
.TP
.B  \-\-allow\-unicode\-control\-chars
Allow unicode control characters (very rarely legitimate)
.TP
.B  \-Q\fP,\fB  \-\-quilt\-ready
Save patches in a quilt\-ready folder
.TP
.B  \-g\fP,\fB  \-\-guess\-base
Try to guess the base of the series (if not specified)
.UNINDENT
.INDENT 7.0
.TP
.B \-b GUESSBRANCH [GUESSBRANCH ...], \-\-guess\-branch GUESSBRANCH [GUESSBRANCH ...]
When guessing base, restrict to this branch (use with \-g)
.UNINDENT
.INDENT 7.0
.TP
.BI \-\-guess\-lookback \ GUESSDAYS
When guessing base, go back this many days from the patch date (default: 2 weeks)
.TP
.B  \-3\fP,\fB  \-\-prep\-3way
Prepare for a 3\-way merge (tries to ensure that all index blobs exist by making a fake commit range)
.TP
.B  \-\-no\-cover
Do not save the cover letter (on by default when using \-o \-)
.TP
.B  \-\-no\-partial\-reroll
Do not reroll partial series when detected
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 am \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
.SS b4 shazam
.sp
This is very similar to \fBb4 am\fP, but will also apply patches
directly to the current git tree using \fBgit am\fP\&. Alternatively, when
used with \fB\-H\fP, it can fetch the patch series into \fBFETCH_HEAD\fP as
if it were a pull request, so it can be reviewed and merged. In this
case, the cover letter is used as a template for the merge commit.
.sp
If you want to automatically invoke git\-merge, you can use \fB\-M\fP
instead of \fB\-H\fP\&.
.INDENT 0.0
.TP
.B usage:
b4 shazam [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-v WANTVER] [\-t] [\-S] [\-T] [\-s] [\-l] [\-P CHERRYPICK] [\-\-cc\-trailers] [\-\-no\-parent] [\-\-allow\-unicode\-control\-chars] [\-H | \-M] [\-\-guess\-lookback GUESSDAYS] [msgid]
.TP
.B positional arguments:
msgid                 Message ID to process, or pipe a raw message
.TP
.B options:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
Use a specific project instead of default (linux\-mm, linux\-hardening, etc)
.TP
.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
.TP
.BI \-\-stdin\-pipe\-sep \ STDIN_PIPE_SEP
When accepting messages on stdin, split using this pipe separator string
.TP
.B  \-C\fP,\fB  \-\-no\-cache
Do not use local cache
.TP
.BI \-v \ WANTVER\fR,\fB \ \-\-use\-version \ WANTVER
Get a specific version of the patch/series
.TP
.B  \-t\fP,\fB  \-\-apply\-cover\-trailers
Apply trailers sent to the cover letter to all patches
.TP
.B  \-S\fP,\fB  \-\-sloppy\-trailers
Apply trailers without email address match checking
.TP
.B  \-T\fP,\fB  \-\-no\-add\-trailers
Do not add or sort any trailers
.TP
.B  \-s\fP,\fB  \-\-add\-my\-sob
Add your own signed\-off\-by to every patch
.TP
.B  \-l\fP,\fB  \-\-add\-link
Add a Link: with message\-id lookup URL to every patch
.TP
.BI \-P \ CHERRYPICK\fR,\fB \ \-\-cherry\-pick \ CHERRYPICK
Cherry\-pick a subset of patches (e.g. \(dq\-P 1\-2,4,6\-\(dq, \(dq\-P _\(dq to use just the msgid specified, or \(dq\-P \fIglobbing\fP\(dq to match on commit subject)
.TP
.B  \-\-cc\-trailers
Copy all Cc\(aqd addresses into Cc: trailers
.TP
.B  \-\-no\-parent
Break thread at the msgid specified and ignore any parent messages
.TP
.B  \-\-allow\-unicode\-control\-chars
Allow unicode control characters (very rarely legitimate)
.TP
.B  \-H\fP,\fB  \-\-make\-fetch\-head
Attempt to treat series as a pull request and fetch it into FETCH_HEAD
.TP
.B  \-M\fP,\fB  \-\-merge
Attempt to merge series as if it were a pull request (execs git\-merge)
.TP
.BI \-\-guess\-lookback \ GUESSDAYS
(use with \-H or \-M) When guessing base, go back this many days from the patch date (default: 3 weeks)
.TP
.BI \-\-merge\-base \ COMMIT
(use with \-H or \-M) Force this base when merging
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 shazam \-H \fI\%20200313231252.64999\-1\-keescook@chromium.org\fP
.SS b4 pr
.sp
This command is for working with pull requests submitted using
\fBgit\-request\-pull\fP\&.
.INDENT 0.0
.TP
.B usage:
command.py pr [\-h] [\-g GITDIR] [\-b BRANCH] [\-c] [\-e] [\-o OUTMBOX] [msgid]
.TP
.B positional arguments:
msgid                 Message ID to process, or pipe a raw message
.TP
.B optional arguments:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-g \ GITDIR\fR,\fB \ \-\-gitdir \ GITDIR
Operate on this git tree instead of current dir
.TP
.BI \-b \ BRANCH\fR,\fB \ \-\-branch \ BRANCH
Check out FETCH_HEAD into this branch after fetching
.TP
.B  \-c\fP,\fB  \-\-check
Check if pull request has already been applied
.TP
.B  \-e\fP,\fB  \-\-explode
Convert a pull request into an mbox full of patches
.TP
.BI \-o \ OUTMBOX\fR,\fB \ \-\-output\-mbox \ OUTMBOX
Save exploded messages into this mailbox (default: msgid.mbx)
.TP
.B  \-l\fP,\fB  \-\-retrieve\-links
Attempt to retrieve any Link: URLs (use with \-e)
.TP
.BI \-f \ MAILFROM\fR,\fB \ \-\-from\-addr \ MAILFROM
Use this From: in exploded messages (use with \-e)
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 pr \fI\%202003292120.2BDCB41@keescook\fP
.SS b4 ty
.INDENT 0.0
.TP
.B usage:
b4 ty [\-h] [\-g GITDIR] [\-o OUTDIR] [\-l] [\-t THANK_FOR [THANK_FOR ...]] [\-d DISCARD [DISCARD ...]] [\-a] [\-b BRANCH] [\-\-since SINCE] [\-S] [\-\-dry\-run]
.TP
.B optional arguments:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-g \ GITDIR\fR,\fB \ \-\-gitdir \ GITDIR
Operate on this git tree instead of current dir
.TP
.BI \-o \ OUTDIR\fR,\fB \ \-\-outdir \ OUTDIR
Write thanks files into this dir (default=.)
.TP
.B  \-l\fP,\fB  \-\-list
List pull requests and patch series you have retrieved
.TP
.BI \-t \ THANK_FOR\fR,\fB \ \-\-thank\-for \ THANK_FOR
Generate thankyous for specific entries from \-l (e.g.: 1,3\-5,7\-; or \(dqall\(dq)
.TP
.BI \-d \ DISCARD\fR,\fB \ \-\-discard \ DISCARD
Discard specific messages from \-l (e.g.: 1,3\-5,7\-; or \(dqall\(dq)
.TP
.B  \-a\fP,\fB  \-\-auto
Use the Auto\-Thankanator gun to figure out what got applied/merged
.TP
.BI \-b \ BRANCH\fR,\fB \ \-\-branch \ BRANCH
The branch to check against, instead of current
.TP
.BI \-\-since \ SINCE
The \-\-since option to use when auto\-matching patches (default=1.week)
.TP
.B  \-S\fP,\fB  \-\-send\-email
Send email instead of writing out .thanks files
.TP
.B  \-\-dry\-run
Print out emails instead of sending them
.TP
.BI \-\-pw\-set\-state \ PW_STATE
Set this patchwork state instead of default (use with \-a, \-t or \-d)
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To send mails directly using \-S, you should have a configured
[sendemail] section somewhere in your applicable git configuration
files (global or in\-tree).
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 ty \-aS \-\-dry\-run
.SS b4 diff
.INDENT 0.0
.TP
.B usage:
b4 diff [\-h] [\-g GITDIR] [\-p USEPROJECT] [\-C] [\-v WANTVERS [WANTVERS ...]] [\-n] [\-o OUTDIFF] [\-c] [\-m AMBOX AMBOX] [msgid]
.TP
.B positional arguments:
msgid                 Message ID to process, pipe a raw message, or use \-m
.UNINDENT
.sp
optional arguments:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-g \ GITDIR\fR,\fB \ \-\-gitdir \ GITDIR
Operate on this git tree instead of current dir
.TP
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
Use a specific project instead of guessing (linux\-mm, linux\-hardening, etc)
.TP
.B  \-C\fP,\fB  \-\-no\-cache
Do not use local cache
.UNINDENT
.INDENT 0.0
.TP
.B \-v WANTVERS [WANTVERS ...], \-\-compare\-versions WANTVERS [WANTVERS ...]
Compare specific versions instead of latest and one before that, e.g. \-v 3 5
.UNINDENT
.INDENT 0.0
.TP
.B  \-n\fP,\fB  \-\-no\-diff
Do not generate a diff, just show the command to do it
.TP
.BI \-o \ OUTDIFF\fR,\fB \ \-\-output\-diff \ OUTDIFF
Save diff into this file instead of outputting to stdout
.TP
.B  \-c\fP,\fB  \-\-color
Force color output even when writing to file
.UNINDENT
.INDENT 0.0
.TP
.B \-m AMBOX AMBOX, \-\-compare\-am\-mboxes AMBOX AMBOX
Compare two mbx files prepared with \(dqb4 am\(dq
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 diff \fI\%20200526205322.23465\-1\-mic@digikod.net\fP
.SS b4 kr
.INDENT 0.0
.TP
.B usage:
b4 kr [\-h] [\-p USEPROJECT] [\-m LOCALMBOX] [\-C] [\-\-show\-keys] [msgid]
.TP
.B positional arguments:
msgid                 Message ID to process, or pipe a raw message
.TP
.B optional arguments:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-p \ USEPROJECT\fR,\fB \ \-\-use\-project \ USEPROJECT
Use a specific project instead of guessing (linux\-mm, linux\-hardening, etc)
.TP
.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
.TP
.BI \-\-stdin\-pipe\-sep \ STDIN_PIPE_SEP
When accepting messages on stdin, split using this pipe separator string
.TP
.B  \-C\fP,\fB  \-\-no\-cache
Do not use local cache
.TP
.B  \-\-show\-keys
Show all developer keys from the thread
.UNINDENT
.UNINDENT
.sp
\fIExample\fP: b4 kr \-\-show\-keys \fI\%20210521184811.617875\-1\-konstantin@linuxfoundation.org\fP
.SS b4 prep
.INDENT 0.0
.TP
.B usage:
b4 prep [\-h] [\-c | \-p OUTPUT_DIR | \-\-edit\-cover | \-\-show\-revision | \-\-force\-revision N | \-\-compare\-to vN | \-\-manual\-reroll COVER_MSGID | \-\-set\-prefixes PREFIX [PREFIX ...] | \-\-show\-info [PARAM] ] | [ \-\-cleanup [BRANCHNAME] ] [\-n NEW_SERIES_NAME] [\-f FORK_POINT] [\-F MSGID] [\-e ENROLL_BASE]
.TP
.B options:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.B  \-c\fP,\fB  \-\-auto\-to\-cc
Automatically populate cover letter trailers with To and Cc addresses
.TP
.BI \-p \ OUTPUT_DIR\fR,\fB \ \-\-format\-patch \ OUTPUT_DIR
Output prep\-tracked commits as patches
.TP
.B  \-\-edit\-cover
Edit the cover letter in your defined $EDITOR (or core.editor)
.TP
.B  \-\-show\-revision
Show current series revision number
.TP
.BI \-\-force\-revision \ N
Force revision to be this number instead
.TP
.BI \-\-compare\-to \ vN
Display a range\-diff to previously sent revision N
.TP
.BI \-\-manual\-reroll \ COVER_MSGID
Mark current revision as sent and reroll (requires cover letter msgid)
.UNINDENT
.INDENT 7.0
.TP
.B \-\-set\-prefixes PREFIX [PREFIX ...]
Extra prefixes to add to [PATCH] (e.g.: RFC mydrv)
.TP
.B \-\-show\-info [PARAM]
Show series info in a format that can be passed to other tools
.TP
.B \-\-cleanup [BRANCHNAME]
Archive and delete obsolete prep\-managed branches
.UNINDENT
.TP
.B Create new branch:
Create a new branch for working on patch series
.INDENT 7.0
.TP
.BI \-n \ NEW_SERIES_NAME\fR,\fB \ \-\-new \ NEW_SERIES_NAME
Create a new branch for working on a patch series
.TP
.BI \-f \ FORK_POINT\fR,\fB \ \-\-fork\-point \ FORK_POINT
When creating a new branch, use this fork point instead of HEAD
.TP
.BI \-F \ MSGID\fR,\fB \ \-\-from\-thread \ MSGID
When creating a new branch, use this thread
.UNINDENT
.TP
.B Enroll existing branch:
Enroll existing branch for prep work
.INDENT 7.0
.TP
.BI \-e \ ENROLL_BASE\fR,\fB \ \-\-enroll \ ENROLL_BASE
Enroll current branch, using the passed tag, branch, or commit as fork base
.UNINDENT
.UNINDENT
.SS b4 send
.INDENT 0.0
.TP
.B usage:
b4 send [\-h] [\-d | \-o OUTPUT_DIR | \-\-dry\-run\-to ADDR [ADDR ...] | \-\-reflect] [\-\-no\-trailer\-to\-cc] [\-\-to ADDR [ADDR ...]] [\-\-cc ADDR [ADDR ...]] [\-\-not\-me\-too] [\-\-resend [vN]] [\-\-no\-sign] [\-\-web\-auth\-new] [\-\-web\-auth\-verify VERIFY_TOKEN]
.TP
.B options:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.B  \-d\fP,\fB  \-\-dry\-run
Do not send, just dump out raw smtp messages to the stdout
.UNINDENT
.INDENT 7.0
.TP
.B \-\-dry\-run\-to ADDR [ADDR ...]
Like \-\-dry\-run, but sends out via email to specified recipients
.UNINDENT
.INDENT 7.0
.TP
.BI \-o \ OUTPUT_DIR\fR,\fB \ \-\-output\-dir \ OUTPUT_DIR
Do not send, write raw messages to this directory (forces \-\-dry\-run)
.TP
.B  \-\-reflect
Send everything to yourself instead of the actual recipients
.TP
.B  \-\-no\-trailer\-to\-cc
Do not add any addresses found in the cover or patch trailers to To: or Cc:
.UNINDENT
.INDENT 7.0
.TP
.B \-\-to ADDR [ADDR ...]
Addresses to add to the To: list
.TP
.B \-\-cc ADDR [ADDR ...]
Addresses to add to the Cc: list
.UNINDENT
.INDENT 7.0
.TP
.B  \-\-not\-me\-too
Remove yourself from the To: or Cc: list
.UNINDENT
.INDENT 7.0
.TP
.B \-\-resend [vN]
Resend a previously sent version of the series
.UNINDENT
.INDENT 7.0
.TP
.B  \-\-no\-sign
Do not add the cryptographic attestation signature header
.UNINDENT
.TP
.B Web submission:
Authenticate with the web submission endpoint
.INDENT 7.0
.TP
.B  \-\-web\-auth\-new
Initiate a new web authentication request
.TP
.BI \-\-web\-auth\-verify \ VERIFY_TOKEN
Submit the token received via verification email
.UNINDENT
.UNINDENT
.SS b4 trailers
.INDENT 0.0
.TP
.B usage:
b4 trailers [\-h] [\-u] [\-S] [\-F MSGID] [\-\-since SINCE]
.TP
.B options:
.INDENT 7.0
.TP
.B  \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.B  \-u\fP,\fB  \-\-update
Update branch commits with latest received trailers
.TP
.B  \-S\fP,\fB  \-\-sloppy\-trailers
Apply trailers without email address match checking
.TP
.BI \-F \ MSGID\fR,\fB \ \-\-trailers\-from \ MSGID
Look for trailers in the thread with this msgid instead of using the series change\-id
.TP
.BI \-\-since \ SINCE
The \-\-since option to use with \-F when auto\-matching patches (default=1.month)
.TP
.BI \-m \ LOCALMBOX\fR,\fB \ \-\-use\-local\-mbox \ LOCALMBOX
Instead of grabbing a thread from lore, process this mbox file (or \- for stdin)
.TP
.BI \-\-stdin\-pipe\-sep \ STDIN_PIPE_SEP
When accepting messages on stdin, split using this pipe separator string
.TP
.B  \-C\fP,\fB  \-\-no\-cache
Do not use local cache
.UNINDENT
.UNINDENT
.SH CONFIGURATION
.sp
B4 configuration is handled via git\-config(1), so you can store it in
either the toplevel $HOME/.gitconfig file, or in a per\-repository
\&.git/config file if your workflow changes per project.
.sp
To see configuration options available, see online documentation at
\fI\%https://b4.docs.kernel.org/en/latest/config.html\fP
.SH PROXYING REQUESTS
.sp
Commands making remote HTTP requests may be configured to use a proxy by
setting the \fBHTTPS_PROXY\fP environment variable, as described in
\fI\%https://docs.python\-requests.org/en/latest/user/advanced/#proxies\fP\&.
.SH SUPPORT
.sp
Please email \fI\%tools@linux.kernel.org\fP with support requests,
or browse the list archive at \fI\%https://lore.kernel.org/tools\fP\&.
.SH AUTHOR
mricon@kernel.org

License: GPLv2+
.SH COPYRIGHT
The Linux Foundation and contributors
.\" Generated by docutils manpage writer.
.