Re: [edk2-platforms PATCH 0/1] Update SMBIOS includes to use capitalization 'Smbios.h' vs 'SmBios.h'

["Leif Lindholm" <leif@nuviainc.com>]

Hi Mike,

OK, that's fair. I was kicking back at the idea that renaming a header
file was too onerous and should never be done.

https://bugzilla.tianocore.org/show_bug.cgi?id=3164 raised.

Rebecca, please keep the current name SmBios.h for the upstreaming of
this library.

Best Regards,

Leif

On Mon, Jan 11, 2021 at 22:28:19 +0000, Kinney, Michael D wrote:
> Leif,
> 
> I would like to see this proposed filename case change split out.
> 
> I am ok with functional changes to follow the SMBIOS Spec.
> 
> I am also ok if the SMBIOS Spec decided to make a non-backwards
> compatible change and we have to follow the change.
> 
> I am also ok if a mistake is made in the translation of 
> SMBIOS spec content to EDK II .h files.  We need to fix
> those.
> 
> The filename case change does not fit into any of the
> above that are required to follow specs required for
> FW functionality.  Changing the case or name of any
> file path in the tree is not related to FW functionality
> and needs to be discussed and reviewed on its own.
> 
> Since this is about consistence with other usage of the
> name "Smbios" or "SmBios" or "SMBios" or "SMBIOS" in
> the source code, we need to discuss all the options to
> make them consist and then understand what the impact is
> to make them consistent.  For example, we could discuss
> changing the Protocol/Guid file name instead of the 
> IndustryStandard filename.  Or just leaving it alone.
> 
> I do not want to see progress slowed on functional
> changes for this one.  Please enter a BZ for the filename
> inconsistency issue so the issue is not lost and progress
> on FW functionality changes can continue.
> 
> Thanks,
> 
> Mike
> 
> 
> > -----Original Message-----
> > From: Leif Lindholm <leif@nuviainc.com>
> > Sent: Monday, January 11, 2021 3:48 AM
> > To: Kinney, Michael D <michael.d.kinney@intel.com>
> > Cc: Rebecca Cran <rebecca@nuviainc.com>; devel@edk2.groups.io; Chaganty, Rangasai V <rangasai.v.chaganty@intel.com>;
> > Liming Gao <gaoliming@byosoft.com.cn>; Steele, Kelly <kelly.steele@intel.com>; Agyeman, Prince <prince.agyeman@intel.com>;
> > Sun, Zailiang <zailiang.sun@intel.com>; Qian, Yi <yi.qian@intel.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>; Wenyi
> > Xie <xiewenyi2@huawei.com>; Chiu, Chasel <chasel.chiu@intel.com>; Ni, Ray <ray.ni@intel.com>; Abner Chang
> > <abner.chang@hpe.com>; Daniel Schaefer <daniel.schaefer@hpe.com>; Gilbert Chen <gilbert.chen@hpe.com>; Thomas Abraham
> > <thomas.abraham@arm.com>; Pete Batard <pete@akeo.ie>; Marcin Wojtas <mw@semihalf.com>
> > Subject: Re: [edk2-platforms PATCH 0/1] Update SMBIOS includes to use capitalization 'Smbios.h' vs 'SmBios.h'
> > 
> > On Mon, Jan 11, 2021 at 04:42:49 +0000, Kinney, Michael D wrote:
> > > Hi Rebecca,
> > >
> > > Where is the review of the change to rename SmBios.h to Smbios.h in MdePkg?
> > >
> > > I do not think that change is a good idea because it would impact
> > > every downstream platform that produces SMBIOS records.
> > 
> > If those platforms are tracking master, this sort of thing should be
> > expected.
> > 
> > If they are jumping between stable tags, they are likely to have more
> > things than this to worry about on each rebase.
> > 
> > If they are "randomly" cherry-picking patches, they will already be
> > used to fixing up much worse things like this.
> > 
> > Not to mention that platforms that build only on Windows and Os X are
> > unlikely to even notice due to case insensitive filesystems. And in my
> > experience, if they ever move to build on a case-sensitive filesystem,
> > they will as a result find many other case typos to fix.
> > 
> > As Sean said:
> > "If a platform dev model can't handle this type of breaking change
> > then this project is paralyzed and bigger things should be addressed."
> > 
> > /
> >     Leif
> > 
> > >
> > > Mike
> > >
> > > > -----Original Message-----
> > > > From: Rebecca Cran <rebecca@nuviainc.com>
> > > > Sent: Sunday, January 10, 2021 7:31 PM
> > > > To: devel@edk2.groups.io
> > > > Cc: Rebecca Cran <rebecca@nuviainc.com>; Chaganty, Rangasai V <rangasai.v.chaganty@intel.com>; Liming Gao
> > > > <gaoliming@byosoft.com.cn>; Kinney, Michael D <michael.d.kinney@intel.com>; Steele, Kelly <kelly.steele@intel.com>;
> > > > Agyeman, Prince <prince.agyeman@intel.com>; Sun, Zailiang <zailiang.sun@intel.com>; Qian, Yi <yi.qian@intel.com>; Leif
> > > > Lindholm <leif@nuviainc.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>; Wenyi Xie <xiewenyi2@huawei.com>; Chiu,
> > Chasel
> > > > <chasel.chiu@intel.com>; Ni, Ray <ray.ni@intel.com>; Abner Chang <abner.chang@hpe.com>; Daniel Schaefer
> > > > <daniel.schaefer@hpe.com>; Gilbert Chen <gilbert.chen@hpe.com>; Thomas Abraham <thomas.abraham@arm.com>; Pete Batard
> > > > <pete@akeo.ie>; Marcin Wojtas <mw@semihalf.com>
> > > > Subject: [edk2-platforms PATCH 0/1] Update SMBIOS includes to use capitalization 'Smbios.h' vs 'SmBios.h'
> > > >
> > > > Update SMBIOS includes to use capitalization 'Smbios.h' vs 'SmBios.h'
> > > >
> > > > This patch depends on the corresponding edk2 change with subject
> > > > "Various packages: rename SmBios.h to Smbios.h in MdePkg and update references through edk2 tree".
> > > >
> > > > Rebecca Cran (1):
> > > >   Update SMBIOS includes to use capitalization 'Smbios.h' vs 'SmBios.h'
> > > >
> > > >  Features/Intel/SystemInformation/SmbiosFeaturePkg/SmbiosFeaturePkg.dec               | 10 +++++-----
> > > >  Features/Intel/SystemInformation/SmbiosFeaturePkg/SmbiosBasicDxe/SmbiosBasic.h       |  2 +-
> > > >  Platform/Intel/QuarkPlatformPkg/Platform/Dxe/MemorySubClass/MemorySubClass.h         |  2 +-
> > > >  Platform/Intel/QuarkPlatformPkg/Platform/Dxe/SmbiosMiscDxe/CommonHeader.h            |  2 +-
> > > >  Platform/Intel/SimicsOpenBoardPkg/Library/BoardBdsHookLib/BoardBdsHook.h             |  4 ++--
> > > >  Platform/Intel/SimicsOpenBoardPkg/Library/PlatformBootManagerLib/BdsPlatform.h       |  4 ++--
> > > >  Platform/Intel/SimicsOpenBoardPkg/SmbiosPlatformDxe/SmbiosPlatformDxe.h              |  2 +-
> > > >  Platform/Intel/Vlv2TbltDevicePkg/SmBiosMiscDxe/CommonHeader.h                        |  2 +-
> > > >  Silicon/Hisilicon/Drivers/Smbios/AddSmbiosType9/AddSmbiosType9.h                     |  2 +-
> > > >  Silicon/Hisilicon/Drivers/Smbios/MemorySubClassDxe/MemorySubClass.h                  |  2 +-
> > > >  Silicon/Hisilicon/Drivers/Smbios/ProcessorSubClassDxe/ProcessorSubClass.h            |  2 +-
> > > >  Silicon/Hisilicon/Drivers/Smbios/SmbiosMiscDxe/SmbiosMisc.h                          |  2 +-
> > > >  Silicon/Intel/CoffeelakeSiliconPkg/Cpu/Library/PeiCpuPolicyLib/PeiCpuPolicyLibrary.h |  2 +-
> > > >  Silicon/Intel/IntelSiliconPkg/Include/IndustryStandard/FirmwareVersionInfo.h         |  2 +-
> > > >  Silicon/Intel/KabylakeSiliconPkg/Cpu/Library/PeiCpuPolicyLib/PeiCpuPolicyLibrary.h   |  2 +-
> > > >  Silicon/RISC-V/ProcessorPkg/Include/ProcessorSpecificHobData.h                       |  2 +-
> > > >  Silicon/RISC-V/ProcessorPkg/Include/SmbiosProcessorSpecificData.h                    |  2 +-
> > > >  Platform/ARM/JunoPkg/SmbiosPlatformDxe/SmbiosPlatformDxe.c                           |  2 +-
> > > >  Platform/Hisilicon/D03/Library/OemMiscLib2P/BoardFeature2PHi1610.c                   |  2 +-
> > > >  Platform/Hisilicon/D05/Library/OemMiscLibD05/BoardFeatureD05.c                       |  2 +-
> > > >  Platform/Hisilicon/D06/Library/OemMiscLibD06/BoardFeatureD06.c                       |  2 +-
> > > >  Platform/Intel/Vlv2TbltDevicePkg/PlatformSetupDxe/SetupInfoRecords.c                 |  2 +-
> > > >  Platform/RaspberryPi/Drivers/PlatformSmbiosDxe/PlatformSmbiosDxe.c                   |  4 ++--
> > > >  Platform/Socionext/DeveloperBox/SmbiosPlatformDxe/SmbiosPlatformDxe.c                |  2 +-
> > > >  Silicon/AMD/Styx/Drivers/PlatformSmbiosDxe/PlatformSmbiosDxe.c                       |  4 ++--
> > > >  Silicon/Intel/IntelSiliconPkg/Library/DxeSmbiosDataHobLib/DxeSmbiosDataHobLib.c      |  2 +-
> > > >  Silicon/Marvell/Drivers/SmbiosPlatformDxe/SmbiosPlatformDxe.c                        |  2 +-
> > > >  27 files changed, 35 insertions(+), 35 deletions(-)
> > > >
> > > > --
> > > > 2.26.2
> > >