0001 LIBNVDIMM Maintainer Entry Profile
0002 ==================================
0003
0004 Overview
0005 --------
0006 The libnvdimm subsystem manages persistent memory across multiple
0007 architectures. The mailing list is tracked by patchwork here:
0008 https://patchwork.kernel.org/project/linux-nvdimm/list/
0009 ...and that instance is configured to give feedback to submitters on
0010 patch acceptance and upstream merge. Patches are merged to either the
0011 'libnvdimm-fixes' or 'libnvdimm-for-next' branch. Those branches are
0012 available here:
0013 https://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git/
0014
0015 In general patches can be submitted against the latest -rc; however, if
0016 the incoming code change is dependent on other pending changes then the
0017 patch should be based on the libnvdimm-for-next branch. However, since
0018 persistent memory sits at the intersection of storage and memory there
0019 are cases where patches are more suitable to be merged through a
0020 Filesystem or the Memory Management tree. When in doubt copy the nvdimm
0021 list and the maintainers will help route.
0022
0023 Submissions will be exposed to the kbuild robot for compile regression
0024 testing. It helps to get a success notification from that infrastructure
0025 before submitting, but it is not required.
0026
0027
0028 Submit Checklist Addendum
0029 -------------------------
0030 There are unit tests for the subsystem via the ndctl utility:
0031 https://github.com/pmem/ndctl
0032 Those tests need to be passed before the patches go upstream, but not
0033 necessarily before initial posting. Contact the list if you need help
0034 getting the test environment set up.
0035
0036 ACPI Device Specific Methods (_DSM)
0037 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0038 Before patches enabling a new _DSM family will be considered, it must
0039 be assigned a format-interface-code from the NVDIMM Sub-team of the ACPI
0040 Specification Working Group. In general, the stance of the subsystem is
0041 to push back on the proliferation of NVDIMM command sets, so do strongly
0042 consider implementing support for an existing command set. See
0043 drivers/acpi/nfit/nfit.h for the set of supported command sets.
0044
0045
0046 Key Cycle Dates
0047 ---------------
0048 New submissions can be sent at any time, but if they intend to hit the
0049 next merge window they should be sent before -rc4, and ideally
0050 stabilized in the libnvdimm-for-next branch by -rc6. Of course if a
0051 patch set requires more than 2 weeks of review, -rc4 is already too late
0052 and some patches may require multiple development cycles to review.
0053
0054
0055 Review Cadence
0056 --------------
0057 In general, please wait up to one week before pinging for feedback. A
0058 private mail reminder is preferred. Alternatively ask for other
0059 developers that have Reviewed-by tags for libnvdimm changes to take a
0060 look and offer their opinion.
