patches and low-level development discussion
 help / color / mirror / code / Atom feed
99adfd2fadfccb7becb2c8cd21574520874d49d9 blob 2470 bytes (raw)

 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
 
= Testing Patches
:page-parent: Patching
:page-grand_parent: Development
:page-nav_order: 1
:toc: preamble

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

Potential changes to Spectrum are posted to and discussed on the
https://spectrum-os.org/participating.html#spectrum-devel[devel@spectrum-os.org]
mailing list.

== Apply Patch

If you haven't already, you'll first need to xref:b4.adoc[install and
configure] https://git.kernel.org/pub/scm/utils/b4/b4.git/about/[b4].
Then:

1. Find the patch series you want to test on https://spectrum-os.org/lists/archives/spectrum-devel/[public-inbox].
2. Navigate to the "permalink" page for any patch in the series.
3. Copy the Message-Id for the patch, as shown on the permalink page, e.g.  \20220511092352.70E54C980@atuin.qyliss.net.
4. 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 `b4 am` with the patch's Message-Id to download all the patches in the series into a file.
+
[source,shell]
----
b4 am 20220511092352.70E54C980@atuin.qyliss.net
----
b4 will indicate the file name it has downloaded the patches into with a line like:
+
[source,shell]
----
Writing ./20220424_hi_host_rootfs_fix_weston_hotplugging.mbx
----
5. Run `git am` on that file to apply the patches, for example:
+
[source,shell]
----
git am 20220424_hi_host_rootfs_fix_weston_hotplugging.mbx
----

== Post Your Results

When you've tested a patch, it's really helpful to
xref:replying.adoc[reply] with your test results.

If the patch worked for you, please reply to it and include a line like the following, separated from any reply text:
[source,shell]
----
Tested-by: John Smith <john@example.com>
----

This format is recognized by tooling, so any lines in this format in
patch replies will be automatically included in the commit message
when a patch is applied.

It's also helpful to explain in your reply how you tested the patch,
but you don't have to if it's obvious.  (For example, if a patch is
supposed to fix a bug, and you verified that after applying the patch
the bug is fixed, just the Tested-by line on its own is enough to
indicate that.)

If you found an issue with the patch, do not include a Tested-by line,
and instead reply to the patch explaining what you tested, what you
expected to happen, and what actually happened.
debug log:

solving 99adfd2 ...
found 99adfd2 in https://spectrum-os.org/lists/archives/spectrum-devel/20220906135533.576642-1-evgeniia.nikolaenko@unikie.com/
found 8ba7804 in https://spectrum-os.org/git/spectrum
preparing index
index prepared:
100644 8ba7804d153f76739bb2aeb4f4302c8ad47cbc25	Documentation/testing-patches.adoc

applying [1/1] https://spectrum-os.org/lists/archives/spectrum-devel/20220906135533.576642-1-evgeniia.nikolaenko@unikie.com/
diff --git a/Documentation/testing-patches.adoc b/Documentation/development/testing-patches.adoc
similarity index 62%
rename from Documentation/testing-patches.adoc
rename to Documentation/development/testing-patches.adoc
index 8ba7804..99adfd2 100644

Checking patch Documentation/testing-patches.adoc => Documentation/development/testing-patches.adoc...
Applied patch Documentation/testing-patches.adoc => Documentation/development/testing-patches.adoc cleanly.

index at:
100644 99adfd2fadfccb7becb2c8cd21574520874d49d9	Documentation/development/testing-patches.adoc

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

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

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).