Commit | Line | Data |
---|---|---|
47843401 DW |
1 | LIBNVDIMM Maintainer Entry Profile |
2 | ================================== | |
3 | ||
4 | Overview | |
5 | -------- | |
6 | The libnvdimm subsystem manages persistent memory across multiple | |
f45ab53f | 7 | architectures. The mailing list is tracked by patchwork here: |
47843401 DW |
8 | https://patchwork.kernel.org/project/linux-nvdimm/list/ |
9 | ...and that instance is configured to give feedback to submitters on | |
10 | patch acceptance and upstream merge. Patches are merged to either the | |
f45ab53f | 11 | 'libnvdimm-fixes' or 'libnvdimm-for-next' branch. Those branches are |
47843401 DW |
12 | available here: |
13 | https://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git/ | |
14 | ||
f45ab53f | 15 | In general patches can be submitted against the latest -rc; however, if |
47843401 DW |
16 | the incoming code change is dependent on other pending changes then the |
17 | patch should be based on the libnvdimm-for-next branch. However, since | |
18 | persistent memory sits at the intersection of storage and memory there | |
19 | are cases where patches are more suitable to be merged through a | |
20 | Filesystem or the Memory Management tree. When in doubt copy the nvdimm | |
21 | list and the maintainers will help route. | |
22 | ||
23 | Submissions will be exposed to the kbuild robot for compile regression | |
24 | testing. It helps to get a success notification from that infrastructure | |
25 | before submitting, but it is not required. | |
26 | ||
27 | ||
28 | Submit Checklist Addendum | |
29 | ------------------------- | |
30 | There are unit tests for the subsystem via the ndctl utility: | |
31 | https://github.com/pmem/ndctl | |
32 | Those tests need to be passed before the patches go upstream, but not | |
33 | necessarily before initial posting. Contact the list if you need help | |
34 | getting the test environment set up. | |
35 | ||
06b9c269 LB |
36 | ACPI Device Specific Methods (_DSM) |
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
f45ab53f | 38 | Before patches enabling a new _DSM family will be considered, it must |
47843401 DW |
39 | be assigned a format-interface-code from the NVDIMM Sub-team of the ACPI |
40 | Specification Working Group. In general, the stance of the subsystem is | |
f45ab53f | 41 | to push back on the proliferation of NVDIMM command sets, so do strongly |
47843401 | 42 | consider implementing support for an existing command set. See |
f45ab53f | 43 | drivers/acpi/nfit/nfit.h for the set of supported command sets. |
47843401 DW |
44 | |
45 | ||
46 | Key Cycle Dates | |
47 | --------------- | |
48 | New submissions can be sent at any time, but if they intend to hit the | |
49 | next merge window they should be sent before -rc4, and ideally | |
50 | stabilized in the libnvdimm-for-next branch by -rc6. Of course if a | |
f45ab53f | 51 | patch set requires more than 2 weeks of review, -rc4 is already too late |
47843401 DW |
52 | and some patches may require multiple development cycles to review. |
53 | ||
54 | ||
55 | Review Cadence | |
56 | -------------- | |
57 | In general, please wait up to one week before pinging for feedback. A | |
58 | private mail reminder is preferred. Alternatively ask for other | |
59 | developers that have Reviewed-by tags for libnvdimm changes to take a | |
60 | look and offer their opinion. |