Messages in this thread Patch in this message | | | Subject | [RFC PATCH 3/3] libnvdimm, MAINTAINERS: Subsystem Profile | From | Dan Williams <> | Date | Wed, 14 Nov 2018 20:53:30 -0800 |
| |
Document the basic policies of the libnvdimm subsystem and provide a first example of a Subsystem Profile for others to duplicate and edit.
Cc: Ross Zwisler <zwisler@kernel.org> Cc: Vishal Verma <vishal.l.verma@intel.com> Cc: Dave Jiang <dave.jiang@intel.com> Signed-off-by: Dan Williams <dan.j.williams@intel.com> --- Documentation/nvdimm/subsystem-profile.rst | 86 ++++++++++++++++++++++++++++ MAINTAINERS | 4 + 2 files changed, 90 insertions(+) create mode 100644 Documentation/nvdimm/subsystem-profile.rst
diff --git a/Documentation/nvdimm/subsystem-profile.rst b/Documentation/nvdimm/subsystem-profile.rst new file mode 100644 index 000000000000..d3428be7528e --- /dev/null +++ b/Documentation/nvdimm/subsystem-profile.rst @@ -0,0 +1,86 @@ +LIBNVDIMM Subsystem Profile +=========================== + +Overview +-------- +So, you have recently become a maintainer of the LIBNVDIMM subsystem, +condolences, it is a thankless job, here is the lay of the land. The git +tree, git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git/, is +writable by all the individuals listed in LIBNVDIMM section of +MAINTAINERS. Access is granted per the typical kernel.org account +management policies. Two branches in that tree are regularly pulled into +-next, libnvdimm-for-next, and libnvdimm-fixes. The submit rate of +patches is low, usually enough for one person to handle. There is a +patchwork instance at +https://patchwork.kernel.org/project/linux-nvdimm/list/, and it +historically is only used for ingesting patches and collecting +ack/review tags, i.e. no expectation to update the patch state after it +has been dispositioned, or merged. + +The most sensitive code area is the ACPI DSM (Device Specific Method) +path. In addition to the general fragility of an ioctl() ABI the ACPI +DSM scheme allows any vendor to implement any command without any prior +review by the ACPI committee. For this reason the LIBNVDIMM system seeks +to constrain the proliferation of vendor commands and at a minimum +requires any command support to be publicly documented. Over time the +submission rate of new vendor-specific commands is falling as more +commands are defined with named methods in the official ACPI +specification. + +LIBNVDIMM sits at the intersection of device-drivers, the block-layer, +core memory-management, and filesystems. Be sure to re-route memory +management patches to the -mm tree, and otherwise pull-in fs-devel for +patches that touch anything related to DAX. + +Core +---- +F: drivers/nvdimm/\*_devs.c +F: drivers/acpi/nfit/\*.[ch] + + +Patches or Pull requests +------------------------ +Patches only + + +Last day for new feature submissions +------------------------------------ +Before -rc5 + + +Last day to merge features +-------------------------- +End of last -rc + + +Non-author Ack / Review Tags Required +------------------------------------- +Required + + +Test Suite +---------- +Run ‘make check’ from https://github.com/pmem/ndctl + + +Trusted Reviewers +----------------- +Johannes Thumshirn +Toshi Kani +Jeff Moyer +Robert Elliott + + +Resubmit Cadence +---------------- +8 business days + + +Time Zone / Office Hours +------------------------ +8:00am to 5:00pm Pacific Time Zone + + +Checkpatch / Style cleanups +--------------------------- +Standalone style-cleanups are welcome. diff --git a/MAINTAINERS b/MAINTAINERS index bb4a83a7684d..ba2beedd4605 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8439,6 +8439,7 @@ M: Dan Williams <dan.j.williams@intel.com> M: Vishal Verma <vishal.l.verma@intel.com> M: Dave Jiang <dave.jiang@intel.com> L: linux-nvdimm@lists.01.org +P: Documentation/nvdimm/subsystem-profile.rst Q: https://patchwork.kernel.org/project/linux-nvdimm/list/ S: Supported F: drivers/nvdimm/blk.c @@ -8450,6 +8451,7 @@ M: Dan Williams <dan.j.williams@intel.com> M: Ross Zwisler <zwisler@kernel.org> M: Dave Jiang <dave.jiang@intel.com> L: linux-nvdimm@lists.01.org +P: Documentation/nvdimm/subsystem-profile.rst Q: https://patchwork.kernel.org/project/linux-nvdimm/list/ S: Supported F: drivers/nvdimm/btt* @@ -8460,6 +8462,7 @@ M: Dan Williams <dan.j.williams@intel.com> M: Vishal Verma <vishal.l.verma@intel.com> M: Dave Jiang <dave.jiang@intel.com> L: linux-nvdimm@lists.01.org +P: Documentation/nvdimm/subsystem-profile.rst Q: https://patchwork.kernel.org/project/linux-nvdimm/list/ S: Supported F: drivers/nvdimm/pmem* @@ -8478,6 +8481,7 @@ M: Ross Zwisler <zwisler@kernel.org> M: Vishal Verma <vishal.l.verma@intel.com> M: Dave Jiang <dave.jiang@intel.com> L: linux-nvdimm@lists.01.org +P: Documentation/nvdimm/subsystem-profile.rst Q: https://patchwork.kernel.org/project/linux-nvdimm/list/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git S: Supported
| |