From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id CFE52B49 for ; Thu, 15 Nov 2018 14:30:55 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id F2E3BD0 for ; Thu, 15 Nov 2018 14:30:54 +0000 (UTC) Date: Thu, 15 Nov 2018 06:30:40 -0800 From: Mauro Carvalho Chehab To: Dan Williams Message-ID: <20181115063040.11eaef93@silica.lan> In-Reply-To: <154225761038.2499188.1270468803677883744.stgit@dwillia2-desk3.amr.corp.intel.com> References: <154225759358.2499188.15268218778137905050.stgit@dwillia2-desk3.amr.corp.intel.com> <154225761038.2499188.1270468803677883744.stgit@dwillia2-desk3.amr.corp.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Cc: Dave Jiang , ksummit-discuss@lists.linuxfoundation.org, linux-nvdimm@lists.01.org, Vishal Verma , linux-kernel@vger.kernel.org, Ross Zwisler Subject: Re: [Ksummit-discuss] [RFC PATCH 3/3] libnvdimm, MAINTAINERS: Subsystem Profile List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Em Wed, 14 Nov 2018 20:53:30 -0800 Dan Williams escreveu: > Document the basic policies of the libnvdimm subsystem and provide a > first example of a Subsystem Profile for others to duplicate and edit. >=20 > Cc: Ross Zwisler > Cc: Vishal Verma > Cc: Dave Jiang > Signed-off-by: Dan Williams > --- > Documentation/nvdimm/subsystem-profile.rst | 86 ++++++++++++++++++++++= ++++++ > MAINTAINERS | 4 + > 2 files changed, 90 insertions(+) > create mode 100644 Documentation/nvdimm/subsystem-profile.rst >=20 > diff --git a/Documentation/nvdimm/subsystem-profile.rst b/Documentation/n= vdimm/subsystem-profile.rst > new file mode 100644 > index 000000000000..d3428be7528e > --- /dev/null > +++ b/Documentation/nvdimm/subsystem-profile.rst Hmm... would it make sense to add a pointer at maintainer/index.rst (or to = some other .rst file) for those profiles too? > @@ -0,0 +1,86 @@ > +LIBNVDIMM Subsystem Profile > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D > + > +Overview > +-------- A minor nitpick here: I would add a blank line after each topic/subtopic. On some cases, Sphinx will do wrong without that blank line, and having some places with that extra line and others without it sounds unbalanced on my eyes ;-) > +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 My understanding that the main focus of this document is to help people to submit patches to the subsystem. With that in mind, I would never start the doc talking only to maintainers, as developers will likely just stop reading it at the above paragraph. > +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. As Jani pointed, all the above stuff is for maintainers, but several other stuff on this document are for developers. The best would likely to have two separate files. However, maintaining it on two separate files could be painful. Maybe we could have an specific section, at the end of the document, with maintainers-specific instructions. > + > +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. This is for developers, so it sounds OK! > + > +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 =E2=80=98make check=E2=80=99 from https://github.com/pmem/ndctl > + > + > +Trusted Reviewers > +----------------- > +Johannes Thumshirn > +Toshi Kani > +Jeff Moyer > +Robert Elliott See my other email commenting about that. > + > + > +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 > M: Vishal Verma > M: Dave Jiang > 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 > M: Ross Zwisler > M: Dave Jiang > 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 > M: Vishal Verma > M: Dave Jiang > 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 > M: Vishal Verma > M: Dave Jiang > 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 >=20 > _______________________________________________ > Ksummit-discuss mailing list > Ksummit-discuss@lists.linuxfoundation.org > https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss Cheers, Mauro From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 8228E2119172A for ; Thu, 15 Nov 2018 06:30:55 -0800 (PST) Date: Thu, 15 Nov 2018 06:30:40 -0800 From: Mauro Carvalho Chehab Subject: Re: [Ksummit-discuss] [RFC PATCH 3/3] libnvdimm, MAINTAINERS: Subsystem Profile Message-ID: <20181115063040.11eaef93@silica.lan> In-Reply-To: <154225761038.2499188.1270468803677883744.stgit@dwillia2-desk3.amr.corp.intel.com> References: <154225759358.2499188.15268218778137905050.stgit@dwillia2-desk3.amr.corp.intel.com> <154225761038.2499188.1270468803677883744.stgit@dwillia2-desk3.amr.corp.intel.com> MIME-Version: 1.0 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" To: Dan Williams Cc: ksummit-discuss@lists.linuxfoundation.org, linux-nvdimm@lists.01.org, linux-kernel@vger.kernel.org, Ross Zwisler List-ID: RW0gV2VkLCAxNCBOb3YgMjAxOCAyMDo1MzozMCAtMDgwMApEYW4gV2lsbGlhbXMgPGRhbi5qLndp bGxpYW1zQGludGVsLmNvbT4gZXNjcmV2ZXU6Cgo+IERvY3VtZW50IHRoZSBiYXNpYyBwb2xpY2ll cyBvZiB0aGUgbGlibnZkaW1tIHN1YnN5c3RlbSBhbmQgcHJvdmlkZSBhCj4gZmlyc3QgZXhhbXBs ZSBvZiBhIFN1YnN5c3RlbSBQcm9maWxlIGZvciBvdGhlcnMgdG8gZHVwbGljYXRlIGFuZCBlZGl0 Lgo+IAo+IENjOiBSb3NzIFp3aXNsZXIgPHp3aXNsZXJAa2VybmVsLm9yZz4KPiBDYzogVmlzaGFs IFZlcm1hIDx2aXNoYWwubC52ZXJtYUBpbnRlbC5jb20+Cj4gQ2M6IERhdmUgSmlhbmcgPGRhdmUu amlhbmdAaW50ZWwuY29tPgo+IFNpZ25lZC1vZmYtYnk6IERhbiBXaWxsaWFtcyA8ZGFuLmoud2ls bGlhbXNAaW50ZWwuY29tPgo+IC0tLQo+ICBEb2N1bWVudGF0aW9uL252ZGltbS9zdWJzeXN0ZW0t cHJvZmlsZS5yc3QgfCAgIDg2ICsrKysrKysrKysrKysrKysrKysrKysrKysrKysKPiAgTUFJTlRB SU5FUlMgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIHwgICAgNCArCj4gIDIgZmlsZXMg Y2hhbmdlZCwgOTAgaW5zZXJ0aW9ucygrKQo+ICBjcmVhdGUgbW9kZSAxMDA2NDQgRG9jdW1lbnRh dGlvbi9udmRpbW0vc3Vic3lzdGVtLXByb2ZpbGUucnN0Cj4gCj4gZGlmZiAtLWdpdCBhL0RvY3Vt ZW50YXRpb24vbnZkaW1tL3N1YnN5c3RlbS1wcm9maWxlLnJzdCBiL0RvY3VtZW50YXRpb24vbnZk aW1tL3N1YnN5c3RlbS1wcm9maWxlLnJzdAo+IG5ldyBmaWxlIG1vZGUgMTAwNjQ0Cj4gaW5kZXgg MDAwMDAwMDAwMDAwLi5kMzQyOGJlNzUyOGUKPiAtLS0gL2Rldi9udWxsCj4gKysrIGIvRG9jdW1l bnRhdGlvbi9udmRpbW0vc3Vic3lzdGVtLXByb2ZpbGUucnN0CgpIbW0uLi4gd291bGQgaXQgbWFr ZSBzZW5zZSB0byBhZGQgYSBwb2ludGVyIGF0IG1haW50YWluZXIvaW5kZXgucnN0IChvciB0byBz b21lCm90aGVyIC5yc3QgZmlsZSkgZm9yIHRob3NlIHByb2ZpbGVzIHRvbz8KCj4gQEAgLTAsMCAr MSw4NiBAQAo+ICtMSUJOVkRJTU0gU3Vic3lzdGVtIFByb2ZpbGUKPiArPT09PT09PT09PT09PT09 PT09PT09PT09PT09Cj4gKwo+ICtPdmVydmlldwo+ICstLS0tLS0tLQoKQSBtaW5vciBuaXRwaWNr IGhlcmU6IEkgd291bGQgYWRkIGEgYmxhbmsgbGluZSBhZnRlciBlYWNoIHRvcGljL3N1YnRvcGlj LgoKT24gc29tZSBjYXNlcywgU3BoaW54IHdpbGwgZG8gd3Jvbmcgd2l0aG91dCB0aGF0IGJsYW5r IGxpbmUsIGFuZCBoYXZpbmcKc29tZSBwbGFjZXMgd2l0aCB0aGF0IGV4dHJhIGxpbmUgYW5kIG90 aGVycyB3aXRob3V0IGl0IHNvdW5kcyB1bmJhbGFuY2VkCm9uIG15IGV5ZXMgOy0pCgo+ICtTbywg eW91IGhhdmUgcmVjZW50bHkgYmVjb21lIGEgbWFpbnRhaW5lciBvZiB0aGUgTElCTlZESU1NIHN1 YnN5c3RlbSwKPiArY29uZG9sZW5jZXMsIGl0IGlzIGEgdGhhbmtsZXNzIGpvYiwgaGVyZSBpcyB0 aGUgbGF5IG9mIHRoZSBsYW5kLiBUaGUgZ2l0CgpNeSB1bmRlcnN0YW5kaW5nIHRoYXQgdGhlIG1h aW4gZm9jdXMgb2YgdGhpcyBkb2N1bWVudCBpcyB0byBoZWxwIHBlb3BsZSB0bwpzdWJtaXQgcGF0 Y2hlcyB0byB0aGUgc3Vic3lzdGVtLgoKV2l0aCB0aGF0IGluIG1pbmQsIEkgd291bGQgbmV2ZXIg c3RhcnQgdGhlIGRvYyB0YWxraW5nIG9ubHkgdG8gbWFpbnRhaW5lcnMsCmFzIGRldmVsb3BlcnMg d2lsbCBsaWtlbHkganVzdCBzdG9wIHJlYWRpbmcgaXQgYXQgdGhlIGFib3ZlIHBhcmFncmFwaC4K Cj4gK3RyZWUsIGdpdC5rZXJuZWwub3JnL3B1Yi9zY20vbGludXgva2VybmVsL2dpdC9udmRpbW0v bnZkaW1tLmdpdC8sIGlzCj4gK3dyaXRhYmxlIGJ5IGFsbCB0aGUgaW5kaXZpZHVhbHMgbGlzdGVk IGluIExJQk5WRElNTSBzZWN0aW9uIG9mCj4gK01BSU5UQUlORVJTLiBBY2Nlc3MgaXMgZ3JhbnRl ZCBwZXIgdGhlIHR5cGljYWwga2VybmVsLm9yZyBhY2NvdW50Cj4gK21hbmFnZW1lbnQgcG9saWNp ZXMuIFR3byBicmFuY2hlcyBpbiB0aGF0IHRyZWUgYXJlIHJlZ3VsYXJseSBwdWxsZWQgaW50bwo+ ICstbmV4dCwgbGlibnZkaW1tLWZvci1uZXh0LCBhbmQgbGlibnZkaW1tLWZpeGVzLiBUaGUgc3Vi bWl0IHJhdGUgb2YKPiArcGF0Y2hlcyBpcyBsb3csIHVzdWFsbHkgZW5vdWdoIGZvciBvbmUgcGVy c29uIHRvIGhhbmRsZS4gVGhlcmUgaXMgYQo+ICtwYXRjaHdvcmsgaW5zdGFuY2UgYXQKPiAraHR0 cHM6Ly9wYXRjaHdvcmsua2VybmVsLm9yZy9wcm9qZWN0L2xpbnV4LW52ZGltbS9saXN0LywgYW5k IGl0Cj4gK2hpc3RvcmljYWxseSBpcyBvbmx5IHVzZWQgZm9yIGluZ2VzdGluZyBwYXRjaGVzIGFu ZCBjb2xsZWN0aW5nCj4gK2Fjay9yZXZpZXcgdGFncywgaS5lLiBubyBleHBlY3RhdGlvbiB0byB1 cGRhdGUgdGhlIHBhdGNoIHN0YXRlIGFmdGVyIGl0Cj4gK2hhcyBiZWVuIGRpc3Bvc2l0aW9uZWQs IG9yIG1lcmdlZC4KPiArCj4gK1RoZSBtb3N0IHNlbnNpdGl2ZSBjb2RlIGFyZWEgaXMgdGhlIEFD UEkgRFNNIChEZXZpY2UgU3BlY2lmaWMgTWV0aG9kKQo+ICtwYXRoLiBJbiBhZGRpdGlvbiB0byB0 aGUgZ2VuZXJhbCBmcmFnaWxpdHkgb2YgYW4gaW9jdGwoKSBBQkkgdGhlIEFDUEkKPiArRFNNIHNj aGVtZSBhbGxvd3MgYW55IHZlbmRvciB0byBpbXBsZW1lbnQgYW55IGNvbW1hbmQgd2l0aG91dCBh bnkgcHJpb3IKPiArcmV2aWV3IGJ5IHRoZSBBQ1BJIGNvbW1pdHRlZS4gRm9yIHRoaXMgcmVhc29u IHRoZSBMSUJOVkRJTU0gc3lzdGVtIHNlZWtzCj4gK3RvIGNvbnN0cmFpbiB0aGUgcHJvbGlmZXJh dGlvbiBvZiB2ZW5kb3IgY29tbWFuZHMgYW5kIGF0IGEgbWluaW11bQo+ICtyZXF1aXJlcyBhbnkg Y29tbWFuZCBzdXBwb3J0IHRvIGJlIHB1YmxpY2x5IGRvY3VtZW50ZWQuIE92ZXIgdGltZSB0aGUK PiArc3VibWlzc2lvbiByYXRlIG9mIG5ldyB2ZW5kb3Itc3BlY2lmaWMgY29tbWFuZHMgaXMgZmFs bGluZyBhcyBtb3JlCj4gK2NvbW1hbmRzIGFyZSBkZWZpbmVkIHdpdGggbmFtZWQgbWV0aG9kcyBp biB0aGUgb2ZmaWNpYWwgQUNQSQo+ICtzcGVjaWZpY2F0aW9uLgoKQXMgSmFuaSBwb2ludGVkLCBh bGwgdGhlIGFib3ZlIHN0dWZmIGlzIGZvciBtYWludGFpbmVycywgYnV0IHNldmVyYWwgb3RoZXIK c3R1ZmYgb24gdGhpcyBkb2N1bWVudCBhcmUgZm9yIGRldmVsb3BlcnMuIFRoZSBiZXN0IHdvdWxk IGxpa2VseSB0byBoYXZlCnR3byBzZXBhcmF0ZSBmaWxlcy4KCkhvd2V2ZXIsIG1haW50YWluaW5n IGl0IG9uIHR3byBzZXBhcmF0ZSBmaWxlcyBjb3VsZCBiZSBwYWluZnVsLiBNYXliZQp3ZSBjb3Vs ZCBoYXZlIGFuIHNwZWNpZmljIHNlY3Rpb24sIGF0IHRoZSBlbmQgb2YgdGhlIGRvY3VtZW50LCB3 aXRoCm1haW50YWluZXJzLXNwZWNpZmljIGluc3RydWN0aW9ucy4KCj4gKwo+ICtMSUJOVkRJTU0g c2l0cyBhdCB0aGUgaW50ZXJzZWN0aW9uIG9mIGRldmljZS1kcml2ZXJzLCB0aGUgYmxvY2stbGF5 ZXIsCj4gK2NvcmUgbWVtb3J5LW1hbmFnZW1lbnQsIGFuZCBmaWxlc3lzdGVtcy4gQmUgc3VyZSB0 byByZS1yb3V0ZSBtZW1vcnkKPiArbWFuYWdlbWVudCBwYXRjaGVzIHRvIHRoZSAtbW0gdHJlZSwg YW5kIG90aGVyd2lzZSBwdWxsLWluIGZzLWRldmVsIGZvcgo+ICtwYXRjaGVzIHRoYXQgdG91Y2gg YW55dGhpbmcgcmVsYXRlZCB0byBEQVguCgpUaGlzIGlzIGZvciBkZXZlbG9wZXJzLCBzbyBpdCBz b3VuZHMgT0shCgo+ICsKPiArQ29yZQo+ICstLS0tCj4gK0Y6IGRyaXZlcnMvbnZkaW1tL1wqX2Rl dnMuYwo+ICtGOiBkcml2ZXJzL2FjcGkvbmZpdC9cKi5bY2hdCj4gKwo+ICsKPiArUGF0Y2hlcyBv ciBQdWxsIHJlcXVlc3RzCj4gKy0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQo+ICtQYXRjaGVzIG9u bHkKPiArCj4gKwo+ICtMYXN0IGRheSBmb3IgbmV3IGZlYXR1cmUgc3VibWlzc2lvbnMKPiArLS0t LS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCj4gK0JlZm9yZSAtcmM1Cj4gKwo+ICsK PiArTGFzdCBkYXkgdG8gbWVyZ2UgZmVhdHVyZXMKPiArLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0t LS0KPiArRW5kIG9mIGxhc3QgLXJjCj4gKwo+ICsKPiArTm9uLWF1dGhvciBBY2sgLyBSZXZpZXcg VGFncyBSZXF1aXJlZAo+ICstLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCj4g K1JlcXVpcmVkCj4gKwo+ICsKPiArVGVzdCBTdWl0ZQo+ICstLS0tLS0tLS0tCj4gK1J1biDigJht YWtlIGNoZWNr4oCZIGZyb20gaHR0cHM6Ly9naXRodWIuY29tL3BtZW0vbmRjdGwKPiArCj4gKwo+ ICtUcnVzdGVkIFJldmlld2Vycwo+ICstLS0tLS0tLS0tLS0tLS0tLQo+ICtKb2hhbm5lcyBUaHVt c2hpcm4KPiArVG9zaGkgS2FuaQo+ICtKZWZmIE1veWVyCj4gK1JvYmVydCBFbGxpb3R0CgpTZWUg bXkgb3RoZXIgZW1haWwgY29tbWVudGluZyBhYm91dCB0aGF0LgoKPiArCj4gKwo+ICtSZXN1Ym1p dCBDYWRlbmNlCj4gKy0tLS0tLS0tLS0tLS0tLS0KPiArOCBidXNpbmVzcyBkYXlzCj4gKwo+ICsK PiArVGltZSBab25lIC8gT2ZmaWNlIEhvdXJzCj4gKy0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQo+ ICs4OjAwYW0gdG8gNTowMHBtIFBhY2lmaWMgVGltZSBab25lCj4gKwo+ICsKPiArQ2hlY2twYXRj aCAvIFN0eWxlIGNsZWFudXBzCj4gKy0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQo+ICtTdGFu ZGFsb25lIHN0eWxlLWNsZWFudXBzIGFyZSB3ZWxjb21lLgo+IGRpZmYgLS1naXQgYS9NQUlOVEFJ TkVSUyBiL01BSU5UQUlORVJTCj4gaW5kZXggYmI0YTgzYTc2ODRkLi5iYTJiZWVkZDQ2MDUgMTAw NjQ0Cj4gLS0tIGEvTUFJTlRBSU5FUlMKPiArKysgYi9NQUlOVEFJTkVSUwo+IEBAIC04NDM5LDYg Kzg0MzksNyBAQCBNOglEYW4gV2lsbGlhbXMgPGRhbi5qLndpbGxpYW1zQGludGVsLmNvbT4KPiAg TToJVmlzaGFsIFZlcm1hIDx2aXNoYWwubC52ZXJtYUBpbnRlbC5jb20+Cj4gIE06CURhdmUgSmlh bmcgPGRhdmUuamlhbmdAaW50ZWwuY29tPgo+ICBMOglsaW51eC1udmRpbW1AbGlzdHMuMDEub3Jn Cj4gK1A6CURvY3VtZW50YXRpb24vbnZkaW1tL3N1YnN5c3RlbS1wcm9maWxlLnJzdAo+ICBROglo dHRwczovL3BhdGNod29yay5rZXJuZWwub3JnL3Byb2plY3QvbGludXgtbnZkaW1tL2xpc3QvCj4g IFM6CVN1cHBvcnRlZAo+ICBGOglkcml2ZXJzL252ZGltbS9ibGsuYwo+IEBAIC04NDUwLDYgKzg0 NTEsNyBAQCBNOglEYW4gV2lsbGlhbXMgPGRhbi5qLndpbGxpYW1zQGludGVsLmNvbT4KPiAgTToJ Um9zcyBad2lzbGVyIDx6d2lzbGVyQGtlcm5lbC5vcmc+Cj4gIE06CURhdmUgSmlhbmcgPGRhdmUu amlhbmdAaW50ZWwuY29tPgo+ICBMOglsaW51eC1udmRpbW1AbGlzdHMuMDEub3JnCj4gK1A6CURv Y3VtZW50YXRpb24vbnZkaW1tL3N1YnN5c3RlbS1wcm9maWxlLnJzdAo+ICBROglodHRwczovL3Bh dGNod29yay5rZXJuZWwub3JnL3Byb2plY3QvbGludXgtbnZkaW1tL2xpc3QvCj4gIFM6CVN1cHBv cnRlZAo+ICBGOglkcml2ZXJzL252ZGltbS9idHQqCj4gQEAgLTg0NjAsNiArODQ2Miw3IEBAIE06 CURhbiBXaWxsaWFtcyA8ZGFuLmoud2lsbGlhbXNAaW50ZWwuY29tPgo+ICBNOglWaXNoYWwgVmVy bWEgPHZpc2hhbC5sLnZlcm1hQGludGVsLmNvbT4KPiAgTToJRGF2ZSBKaWFuZyA8ZGF2ZS5qaWFu Z0BpbnRlbC5jb20+Cj4gIEw6CWxpbnV4LW52ZGltbUBsaXN0cy4wMS5vcmcKPiArUDoJRG9jdW1l bnRhdGlvbi9udmRpbW0vc3Vic3lzdGVtLXByb2ZpbGUucnN0Cj4gIFE6CWh0dHBzOi8vcGF0Y2h3 b3JrLmtlcm5lbC5vcmcvcHJvamVjdC9saW51eC1udmRpbW0vbGlzdC8KPiAgUzoJU3VwcG9ydGVk Cj4gIEY6CWRyaXZlcnMvbnZkaW1tL3BtZW0qCj4gQEAgLTg0NzgsNiArODQ4MSw3IEBAIE06CVJv c3MgWndpc2xlciA8endpc2xlckBrZXJuZWwub3JnPgo+ICBNOglWaXNoYWwgVmVybWEgPHZpc2hh bC5sLnZlcm1hQGludGVsLmNvbT4KPiAgTToJRGF2ZSBKaWFuZyA8ZGF2ZS5qaWFuZ0BpbnRlbC5j b20+Cj4gIEw6CWxpbnV4LW52ZGltbUBsaXN0cy4wMS5vcmcKPiArUDoJRG9jdW1lbnRhdGlvbi9u dmRpbW0vc3Vic3lzdGVtLXByb2ZpbGUucnN0Cj4gIFE6CWh0dHBzOi8vcGF0Y2h3b3JrLmtlcm5l bC5vcmcvcHJvamVjdC9saW51eC1udmRpbW0vbGlzdC8KPiAgVDoJZ2l0IGdpdDovL2dpdC5rZXJu ZWwub3JnL3B1Yi9zY20vbGludXgva2VybmVsL2dpdC9udmRpbW0vbnZkaW1tLmdpdAo+ICBTOglT dXBwb3J0ZWQKPiAKPiBfX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fXwo+IEtzdW1taXQtZGlzY3VzcyBtYWlsaW5nIGxpc3QKPiBLc3VtbWl0LWRpc2N1c3NAbGlz dHMubGludXhmb3VuZGF0aW9uLm9yZwo+IGh0dHBzOi8vbGlzdHMubGludXhmb3VuZGF0aW9uLm9y Zy9tYWlsbWFuL2xpc3RpbmZvL2tzdW1taXQtZGlzY3VzcwoKCgoKQ2hlZXJzLApNYXVybwpfX19f X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fXwpMaW51eC1udmRpbW0g bWFpbGluZyBsaXN0CkxpbnV4LW52ZGltbUBsaXN0cy4wMS5vcmcKaHR0cHM6Ly9saXN0cy4wMS5v cmcvbWFpbG1hbi9saXN0aW5mby9saW51eC1udmRpbW0K From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-11.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BEE8AC43441 for ; Thu, 15 Nov 2018 14:30:56 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 780ED21582 for ; Thu, 15 Nov 2018 14:30:56 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="RN0ulnK4" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 780ED21582 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2388319AbeKPAi6 (ORCPT ); Thu, 15 Nov 2018 19:38:58 -0500 Received: from bombadil.infradead.org ([198.137.202.133]:48062 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729034AbeKPAi5 (ORCPT ); Thu, 15 Nov 2018 19:38:57 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To: From:Date:Sender:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=13GjQAwG2XhFWnrd76t6ce0eSS3JyU9WsK9Y9zGJ6O8=; b=RN0ulnK4N95ENPHVIZZj6cDQ7 UjsUya0NS+ZDvvtEqJmYrLufV3CHdTyl1Bbxe7IcZ39Im8DqbkPltftroZzMargVw1BU9R1YeEABp PDA2csMMOyJPamJB6pZnY8Oe6SjGkWrO7J0+co0TBu85RzHWFohmf/IwM9YjzrLj57NayAhT63NGe EIpN9oS8SA4+pDWLNTMEuoGsoA+4JY9u5qRDY0RhWydH5sJ/8D9NCZ3Y5BJbKuhf6swabRSxR7e3D eJCj/ULigUox05utTniFsMF7vf3xVa+JUwYPOYlycnuCl7Sc5OwOKtc/yoHygPHQaduXsQVEBAJN4 seyA/tAmw==; Received: from 189.27.28.95.dynamic.adsl.gvt.net.br ([189.27.28.95] helo=silica.lan) by bombadil.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1gNIfS-0001P8-QU; Thu, 15 Nov 2018 14:30:51 +0000 Date: Thu, 15 Nov 2018 06:30:40 -0800 From: Mauro Carvalho Chehab To: Dan Williams Cc: linux-kernel@vger.kernel.org, Dave Jiang , ksummit-discuss@lists.linuxfoundation.org, linux-nvdimm@lists.01.org, Vishal Verma , Ross Zwisler Subject: Re: [Ksummit-discuss] [RFC PATCH 3/3] libnvdimm, MAINTAINERS: Subsystem Profile Message-ID: <20181115063040.11eaef93@silica.lan> In-Reply-To: <154225761038.2499188.1270468803677883744.stgit@dwillia2-desk3.amr.corp.intel.com> References: <154225759358.2499188.15268218778137905050.stgit@dwillia2-desk3.amr.corp.intel.com> <154225761038.2499188.1270468803677883744.stgit@dwillia2-desk3.amr.corp.intel.com> X-Mailer: Claws Mail 3.16.0 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Wed, 14 Nov 2018 20:53:30 -0800 Dan Williams escreveu: > Document the basic policies of the libnvdimm subsystem and provide a > first example of a Subsystem Profile for others to duplicate and edit. >=20 > Cc: Ross Zwisler > Cc: Vishal Verma > Cc: Dave Jiang > Signed-off-by: Dan Williams > --- > Documentation/nvdimm/subsystem-profile.rst | 86 ++++++++++++++++++++++= ++++++ > MAINTAINERS | 4 + > 2 files changed, 90 insertions(+) > create mode 100644 Documentation/nvdimm/subsystem-profile.rst >=20 > diff --git a/Documentation/nvdimm/subsystem-profile.rst b/Documentation/n= vdimm/subsystem-profile.rst > new file mode 100644 > index 000000000000..d3428be7528e > --- /dev/null > +++ b/Documentation/nvdimm/subsystem-profile.rst Hmm... would it make sense to add a pointer at maintainer/index.rst (or to = some other .rst file) for those profiles too? > @@ -0,0 +1,86 @@ > +LIBNVDIMM Subsystem Profile > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D > + > +Overview > +-------- A minor nitpick here: I would add a blank line after each topic/subtopic. On some cases, Sphinx will do wrong without that blank line, and having some places with that extra line and others without it sounds unbalanced on my eyes ;-) > +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 My understanding that the main focus of this document is to help people to submit patches to the subsystem. With that in mind, I would never start the doc talking only to maintainers, as developers will likely just stop reading it at the above paragraph. > +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. As Jani pointed, all the above stuff is for maintainers, but several other stuff on this document are for developers. The best would likely to have two separate files. However, maintaining it on two separate files could be painful. Maybe we could have an specific section, at the end of the document, with maintainers-specific instructions. > + > +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. This is for developers, so it sounds OK! > + > +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 =E2=80=98make check=E2=80=99 from https://github.com/pmem/ndctl > + > + > +Trusted Reviewers > +----------------- > +Johannes Thumshirn > +Toshi Kani > +Jeff Moyer > +Robert Elliott See my other email commenting about that. > + > + > +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 > M: Vishal Verma > M: Dave Jiang > 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 > M: Ross Zwisler > M: Dave Jiang > 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 > M: Vishal Verma > M: Dave Jiang > 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 > M: Vishal Verma > M: Dave Jiang > 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 >=20 > _______________________________________________ > Ksummit-discuss mailing list > Ksummit-discuss@lists.linuxfoundation.org > https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss Cheers, Mauro