From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by mx.groups.io with SMTP id smtpd.web12.8677.1588258775835658898 for ; Thu, 30 Apr 2020 07:59:36 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@nuviainc-com.20150623.gappssmtp.com header.s=20150623 header.b=Y1HO0JtT; spf=pass (domain: nuviainc.com, ip: 209.85.221.66, mailfrom: leif@nuviainc.com) Received: by mail-wr1-f66.google.com with SMTP id i10so7296875wrv.10 for ; Thu, 30 Apr 2020 07:59:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nuviainc-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to :user-agent; bh=Z1rJo5EQ7gAX8M3sIPCXDKv7W/h6GE5d8KnWtLi0bI8=; b=Y1HO0JtTysdGpM+2SDrgeBgiqWwXjoyuvQdb2wG90qYVF3UvNaTEtm318MOPNaxac9 hPzeoPeQSuDPWLQE9Cveez8PwJucFSckfEayAJFrV2jXq9Qd0rMrXms/wrNfz/586Tph xh4X1HnVg0fyIHZUDpnPx0yfpfegJrpgfmzDD5YiKQh6OuTCKXVscbVUgQWTSiAygzzE c8lH3kQbmycJMyzQ2A5x4SiOCivvf3Vc/TEvd/WVFVe/skDI02pgdZwD+8YX1EyzyKF+ BsbS7XQqSKFxQe5/IsNE3VMqKWxjX7YrwiAdHcFkRwznMymecU8WEtfP4UJwu12GvZN2 EshA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to:user-agent; bh=Z1rJo5EQ7gAX8M3sIPCXDKv7W/h6GE5d8KnWtLi0bI8=; b=Puujhcx6Jx7e4Ty+VF7HIutgDqKEsFwVnLLIv0sDJ1zTnz0aK9Qr0PyQofcEkof5WM e3iUcTin1pO9oxAa39IgyenYXfI/ipIZAQ7cwtTw/Mpt85E/rSZH34EJEypuvjPqUAhG pA7J1fE4kZ91odEO1iIN/y94zixTi3nq0+KBvisliwW0DVH9uaWxOQYQoVgkAW3PVVm5 0WZz7Yok+yQRfJr9eqLe/vSQ8YU0EVB/Mfh7/SkIeBoqpHZThd/7iNYb45AJ2vi8yCze p+mNYTGI+9u1QdHHVNRwJ2SM3yklrg2RmKJRRiL2fEYW8ViiA6UUwCTSpx3Un38+Sncx 6SaA== X-Gm-Message-State: AGi0PublgACxCoJUQr1QOCTr36qtual6UmlqYsH/yy70XQgwFQhBrakg lYj0OzAfl3M7oBv1r9fwICQyow== X-Google-Smtp-Source: APiQypIWuemnCArzndOFtYCRQotAuASuaTEhvBWYfdrBcyQyl5hrbqJtSwA0Wvlvk6fcrYyh0AY67w== X-Received: by 2002:adf:ce0a:: with SMTP id p10mr4216047wrn.89.1588258774436; Thu, 30 Apr 2020 07:59:34 -0700 (PDT) Return-Path: Received: from vanye ([2001:470:1f09:12f0:b26e:bfff:fea9:f1b8]) by smtp.gmail.com with ESMTPSA id a9sm11983350wmm.38.2020.04.30.07.59.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 30 Apr 2020 07:59:33 -0700 (PDT) Date: Thu, 30 Apr 2020 15:59:29 +0100 From: "Leif Lindholm" To: Ard Biesheuvel Cc: Laszlo Ersek , devel@edk2.groups.io, Andrew Fish , Bob Feng , Liming Gao , Michael D Kinney Subject: Re: [PATCH 0/3] BaseTools,EmbeddedPkg,Maintainers.txt: Obsolete some drivers Message-ID: <20200430145929.GW21486@vanye> 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> MIME-Version: 1.0 In-Reply-To: User-Agent: Mutt/1.10.1 (2018-07-13) Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit On Thu, Apr 30, 2020 at 15:43:22 +0200, Ard Biesheuvel wrote: > > > > > Thinking a bit more on this, maybe what we should do is add a template > > > > > to each file's top comment block. Draft proposal: > > > > > > > > > >    * > > > > >    * WARNING: > > > > >    * This driver fails to follow the UEFI driver model without a good > > > > >    * reason, and only remains in the tree because it is still used by > > > > >    * a small number of platforms. It will removed when no longer used. > > > > >    * New platforms should not use it, and no one should use this as > > > > >    * reference code for developing new drivers. > > > > >    * > > > > > > > > > > > > > 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. > > > > 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. > > > > 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. > > > > Ard? > > > > Agreed. People tend to look at the file header when they add their > copyright, so putting it in each file seems like a sensible way to do this. > > As for using the likes of MmcDxe: perhaps we should add a i-am-deprecated > PCD that defaults to a value that prevents it from working? Yes, that's even better! / Leif