aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 5ffa652fa41d01113ae8893efbd85ff6588e187a (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
This is a helper utility to work with patches 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.

The name "b4" was chosen for ease of typing and because B-4 was the
precursor to Lore and Data in the Star Trek universe.

See man/b4.5.rst for more information.

Installing
----------
```
python3 -m pip install --user b4
```

Upgrading
---------
```
python3 -m pip install --user --upgrade b4
```

Running from the checkout dir
-----------------------------
If you want to run from the checkout dir without installing the python
package, you can use the included b4.sh wrapper. You can set it as an
alias in your .bash_profile::

    alias b4="$HOME/path/to/b4/b4.sh"

Support
-------
For support or with any other questions, please email
tools@linux.kernel.org.