From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web11.7291.1588254206449608172 for ; Thu, 30 Apr 2020 06:43:26 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: ard.biesheuvel@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 122E11063; Thu, 30 Apr 2020 06:43:25 -0700 (PDT) Received: from [192.168.1.81] (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id F41913F73D; Thu, 30 Apr 2020 06:43:23 -0700 (PDT) Subject: Re: [PATCH 0/3] BaseTools,EmbeddedPkg,Maintainers.txt: Obsolete some drivers To: Leif Lindholm , Laszlo Ersek Cc: devel@edk2.groups.io, Andrew Fish , Bob Feng , Liming Gao , Michael D Kinney References: <20200429163616.5951-1-leif@nuviainc.com> <10151f16-f903-6fcf-92c8-f28f269eab53@arm.com> <20200429195343.GI21486@vanye> <464be692-53ef-8cac-ec69-2f87cc6f59cb@arm.com> <20200429214531.GN21486@vanye> <83cf98dc-ec56-2712-2835-e9b4c99049c9@arm.com> <20200430132843.GS21486@vanye> From: "Ard Biesheuvel" Message-ID: Date: Thu, 30 Apr 2020 15:43:22 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.7.0 MIME-Version: 1.0 In-Reply-To: <20200430132843.GS21486@vanye> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: quoted-printable On 4/30/20 3:28 PM, Leif Lindholm wrote: > On Thu, Apr 30, 2020 at 13:17:26 +0200, Laszlo Ersek wrote: >> On 04/29/20 23:47, Ard Biesheuvel wrote: >>> On 4/29/20 11:45 PM, Leif Lindholm wrote: >>>> On Wed, Apr 29, 2020 at 22:04:08 +0200, Ard Biesheuvel wrote: >>>>>>> I am mostly concerned about the use of MmcDxe in new platforms. T= he >>>>>>> other >>>>>>> bits I'm not too worried about, and I think it would be fine to >>>>>>> move those >>>>>>> into Platform/ARM/VExpressPkg in edk2-platforms, instead of hopin= g >>>>>>> that >>>>>>> someone will turn up and turn them into driver model drivers. >>>>>> >>>>>> We could, although I would prefer not adding code to edk2-platform= s >>>>>> that would not be accepted was it submitted as a new contribution. >>>>>> The SATA controller, I would ideally re-review and merge properly. >>>>>> >>>>>> If we do include the other drivers in platform-specific directorie= s, I >>>>>> want them to come with ... strongly worded readmes. >>>>>> >>>>> >>>>> Right. >>>>> >>>>> Should we have some format for that? A way to log shortcomings alon= g >>>>> with >>>>> the code? >>>> >>>> Thinking a bit more on this, maybe what we should do is add a templa= te >>>> to each file's top comment block. Draft proposal: >>>> >>>> =C2=A0=C2=A0 * >>>> =C2=A0=C2=A0 * WARNING: >>>> =C2=A0=C2=A0 * This driver fails to follow the UEFI driver model wi= thout a good >>>> =C2=A0=C2=A0 * reason, and only remains in the tree because it is s= till used by >>>> =C2=A0=C2=A0 * a small number of platforms. It will removed when no= longer used. >>>> =C2=A0=C2=A0 * New platforms should not use it, and no one should u= se this as >>>> =C2=A0=C2=A0 * reference code for developing new drivers. >>>> =C2=A0=C2=A0 * >>>> >>> >>> Works for me >>> >> >> You could also (or alternatively) add a separate file "DEPRECATED.txt" >> to the directory -- sometimes people don't read file-top comments, >> before duplicating or editing code. Something that's visible with a >> simple "ls -l" might stand out more. >=20 > I think what's more visible depends on the use-case. > A comment at the top of the file is at least very visible to the > reviewer if someone submits Yet Another Clone of an inadvisible > driver. >=20 > A DEPRECATED.txt might be a good ide for something like the > EmbeddedPkg MmcDxe which we wan't people to stop *using* as opposed to > copying. >=20 > Ard? >=20 Agreed. People tend to look at the file header when they add their=20 copyright, so putting it in each file seems like a sensible way to do thi= s. As for using the likes of MmcDxe: perhaps we should add a=20 i-am-deprecated PCD that defaults to a value that prevents it from workin= g?