From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp-relay-internal-0.canonical.com (smtp-relay-internal-0.canonical.com [185.125.188.122]) by mx.groups.io with SMTP id smtpd.web11.3891.1670376161276039443 for ; Tue, 06 Dec 2022 17:22:41 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@canonical.com header.s=20210705 header.b=RNTDzS29; spf=pass (domain: canonical.com, ip: 185.125.188.122, mailfrom: dann.frazier@canonical.com) Received: from mail-il1-f200.google.com (mail-il1-f200.google.com [209.85.166.200]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by smtp-relay-internal-0.canonical.com (Postfix) with ESMTPS id 5239244346 for ; Wed, 7 Dec 2022 01:22:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=canonical.com; s=20210705; t=1670376159; bh=zWnrzw9ZkLRfvfRn2JCYcZ2sjYyPB3mEiCXm9ycNfTU=; h=MIME-Version:References:In-Reply-To:From:Date:Message-ID:Subject: To:Cc:Content-Type; b=RNTDzS29brc7cml8zjSLi1nTKgEpytIK95dWU8h0sR66u1yDe3z7V4qQ1bIbtlrGA LCUr8OJWTD+a1plSljQ6MnCEgRuSF98dv3SOGbZycGCsj6y4hZLntNvfsYbDHiYW6v zb7NcWerxu0vaCoQLt9FbjAPxUVO7DVhJOOtDbgFSzi7WC7j1B/80Ffo/oF4fBkc1t N8d+BipBZl1hxWEWF6/TveyaI9zGD7p69vw+MNIT6hs2Oaq0cYFYgkgeXYjPCPYY7a eKJGLAxM6rF5tXYV62ylFGW8ZibOHODrHQN2J6W687vLS5VfG2UAEtu1Ne/kt9RwkE 6ROJWC03zbBvA== Received: by mail-il1-f200.google.com with SMTP id a14-20020a921a0e000000b00302a8ffa8e5so15537854ila.2 for ; Tue, 06 Dec 2022 17:22:39 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=zWnrzw9ZkLRfvfRn2JCYcZ2sjYyPB3mEiCXm9ycNfTU=; b=dfJdmfOJfYhrd8UzXRkI/oPHpHoYtiOWOZ5C/tpiNVkvX6hHqfDWC68Or3ZEzUeFbm cPocK04PblI+RPAbKh3w3oMwQsMz3sBoKKIUM2lrGgQ6+Eofdyg4AacXRX9xTC4a38p7 HHiVaRMT5yFKzEQHT/ItPH3ffej7coTNYpEbVzr/B1BW0dnx2BFFQsIiO4hFFvMz9gZb cvif7/zQXmROdP5DVqc22soH8XESZCbUi4EaHd230sM6f56dLW+kxczgQ2HaOWUbty9F hpI6zXPUxSXz0yUWIz7O0CrwBJDojk0ZwDxfzD//DYuBDF+aG+U4Z72SyahPXRAZpfLD 7PzA== X-Gm-Message-State: ANoB5pnDlwXKlNtuGoIp8C1lg0JFNbLD7sVUW6keaHy/qEQsDO0FSWZY zkKB3HV0+OiEc0ll0p/kVfafWyCrm9Si9Z0lCNv4NJOEmlxgGLSVc5zUoMQ0XhjGE82GoBStGdl nSMgoNolxds8K8aGme7d9Mz9JeLD+LdOmJsxrsV2lX8NSlM0= X-Received: by 2002:a02:a593:0:b0:38a:590c:f742 with SMTP id b19-20020a02a593000000b0038a590cf742mr3302360jam.201.1670376157389; Tue, 06 Dec 2022 17:22:37 -0800 (PST) X-Google-Smtp-Source: AA0mqf5ylh6d1okzYQKmOzVGwzhx+u8TUP8Q0mLATTpU4+8Oer3H9ReLFTXuCOrhyX93qhDg8cww76HRI5I3ktB74RY= X-Received: by 2002:a02:a593:0:b0:38a:590c:f742 with SMTP id b19-20020a02a593000000b0038a590cf742mr3302354jam.201.1670376157108; Tue, 06 Dec 2022 17:22:37 -0800 (PST) MIME-Version: 1.0 References: In-Reply-To: From: "dann frazier" Date: Tue, 6 Dec 2022 18:22:25 -0700 Message-ID: Subject: Re: [edk2-devel] feature flag change notifications To: "Kinney, Michael D" Cc: "devel@edk2.groups.io" , "Gao, Liming" Content-Type: text/plain; charset="UTF-8" Hi Mike, Thanks for the consideration. I think the release notes are a sufficient starting point. -dann On Mon, Dec 5, 2022 at 6:22 PM Kinney, Michael D wrote: > > Hi Dann, > > These are reasonable requests. > > Adding Liming Gao who is currently responsible for the edk2 releases. > > Let's start with release notes and see if some of these can be added > to the release documentation and add to the edk2 release process > to clearly note these type of changes in future release notes. > > As far as #error and #warn. Those are possible, but we would need > to do some analysis for the types of changes that would require > that behavior. Your examples are useful as a starting point. > > Once concern is how many of those #error/#warn conditions will > build up over time and then a process to remove them after an > expiration period. > > Mike > > > -----Original Message----- > > From: devel@edk2.groups.io On Behalf Of dann frazier > > Sent: Monday, December 5, 2022 4:10 PM > > To: devel@edk2.groups.io > > Subject: [edk2-devel] feature flag change notifications > > > > Hi, > > I maintain the edk2 packages in the Debian and Ubuntu > > distributions. A few times over the years I've had users report > > regressions that turned out to be due to upstream build flag > > changes. I wonder if it would be possible for upstream to communicate > > such changes - either via release notes or, where possible, as > > build-time checks - to us downstream projects. Here are the examples I > > recall: > > > > > commit 4de8d61bcec02a13ceed84f92b0cf3ea58adf9c5 > > > Author: Gerd Hoffmann > > > Date: Wed Dec 15 12:39:20 2021 +0100 > > > > > > OvmfPkg: rework TPM configuration > > > > > > > For this I needed to change -DTPM_ENABLE=TRUE to -DTPM2_ENABLE=TRUE. I > > feel like a build-time check would've been a good way to communicate > > this one, e.g.: > > > > #ifdef TPM_ENABLE > > #error TPM_ENABLE has been renamed to TPM2_ENABLE > > #endif > > > > > commit 1631bb26ae991e530d3c96fe3161ea15144b358e > > > Author: Gary Lin > > > Date: Mon Jun 10 14:55:09 2019 +0800 > > > > > > OvmfPkg/README: Update the network build flags > > > > > > The following network build flags changed due to the inclusion of > > > NetworkPkg/Network.fdf.inc. > > > > > Similar to the above, I needed to deal with this by setting > > -DNETWORK_HTTP_BOOT_ENABLE=TRUE instead of -DHTTP_BOOT_ENABLE=TRUE. It > > seems like maybe an #error on the removed #define could've helped > > here as well. > > > > And finally: > > > > > commit 57783adfb579da32b1eeda77b2bec028a5e0b7b3 > > > Author: Michael D Kinney > > > Date: Tue Jul 26 12:40:00 2022 -0700 > > > > > > OvmfPkg: Change default to disable MptScsi and PvScsi > > > > With this types of change, it would be useful just to know this is > > coming and why so I can decide to either notify users of the change > > and/or override the default to avoid the regression. Would it be > > possible to describe such changes in the release notes at > > https://github.com/tianocore/edk2/releases - and, if not urgent, > > perhaps #warn of deprecation in the source for one stable release > > cycle? > > > > -dann > > > > > > > > >