patches and low-level development discussion
 help / color / mirror / code / Atom feed
blob 1ba87b22c85e4bb0b9c66a07b0dd3350418aae70 1390 bytes (raw)
name: Documentation/installation/b4.adoc 	 # note: path name is non-authoritative(*)

 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
 
= Installing and Configuring b4
:page-parent: Build and Run
:page-nav_order: 3

// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0

https://git.kernel.org/pub/scm/utils/b4/b4.git/about/[b4] is a utility
for working with patches sent to a mailing list, such as
https://spectrum-os.org/participating.html#spectrum-devel[devel@spectrum-os.org].

== Installing b4

You should be able to install b4 from your package manager.

Using Nix, you can start a shell with b4 available by running

[listing]
[source,shell]
nix-shell -p b4

== Configuring b4

As b4 was originally written for Linux development, it will default to
searching for patches on the Linux mailing lists.  So to use it for
Spectrum, it needs to be configured to search the Spectrum mailing
lists instead.

To do this, in a checkout of the appropriate git repository
(https://spectrum-os.org/git/spectrum[Spectrum] or
https://spectrum-os.org/git/nixpkgs[Spectrum Nixpkgs]), run:

[listing]
[source,shell]
git config b4.midmask https://spectrum-os.org/lists/archives/spectrum-devel/%s

From now on, any b4 command run in Spectrum repositories will search
the Spectrum devel mailing list.

== Using b4

Using b4 to fetch and apply a patch from the Spectrum mailing list is
described in the xref:testing-patches.adoc[Testing Patches] how-to guide.

debug log:

solving 1ba87b2 ...
found 1ba87b2 in https://inbox.spectrum-os.org/spectrum-devel/20220906135533.576642-1-evgeniia.nikolaenko@unikie.com/
found 2519894 in https://spectrum-os.org/git/spectrum
preparing index
index prepared:
100644 2519894b1b2828863998446b720914fdd73afdcb	Documentation/b4.adoc

applying [1/1] https://inbox.spectrum-os.org/spectrum-devel/20220906135533.576642-1-evgeniia.nikolaenko@unikie.com/
diff --git a/Documentation/b4.adoc b/Documentation/installation/b4.adoc
similarity index 96%
rename from Documentation/b4.adoc
rename to Documentation/installation/b4.adoc
index 2519894..1ba87b2 100644

Checking patch Documentation/b4.adoc => Documentation/installation/b4.adoc...
Applied patch Documentation/b4.adoc => Documentation/installation/b4.adoc cleanly.

index at:
100644 1ba87b22c85e4bb0b9c66a07b0dd3350418aae70	Documentation/installation/b4.adoc

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock

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 NNTP newsgroup(s).