On 07/07/16 11:08, peter.kirme...@ts.fujitsu.com wrote: > Hi Liming, > > yes I see, but there are lots of people not reading every single > patch note of this email list or don't even are part of the list.
People who consume edk2 (even as proprietary downstreams) should definitely be on this list. > However, also newcomers who don't know the past (or this email list > at all) won't know anything about such changes happening in the > background. The mailing list has an archive :) > Therefore it is essential to update the documentation of > the source code accordingly. In best case the documentation is part > of the PATCH itself, like an README update. I agree. Critical information is best included in patches and/or docs files, not just cover letters of patch series. Cover letters are not captured in the git commit history. (Unfortunately!) > Moreover especially for > changes, which take effect on the build environment or dependencies > to third party software, it is absolutely necessary to document these > changes, so everyone can see what was going on and/or what they have > to do. I guess the series in question should have patched "BaseTools/BuildNotes.txt" and/or "BaseTools/ReadMe.txt"? In OvmfPkg, when we add a bigger feature, we modify OvmfPkg/README. That text file has some general hints too; for example, how to capture the OVMF debug log. In my experience though, people generally ignore OvmfPkg/README. They tend to find this list and ask questions here much earlier than they read OvmfPkg/README. I agree that up-to-date documentation is important, but I also see that many people ignore such documentation just because it's not offered to them in their preferred format / avenue. Thanks Laszlo > > Best Regards, > Peter > > > -----Original Message----- > From: Gao, Liming [mailto:liming....@intel.com] > Sent: Thursday, July 07, 2016 10:49 AM > To: Kirmeier, Peter; edk2-devel@lists.01.org > Subject: RE: Build fails due to missing NASM > > Peter: > I mention such information in my sent patch to edk2 community. Please see > http://article.gmane.org/gmane.comp.bios.edk2.devel/13297 > > Thanks > Liming >> -----Original Message----- >> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of >> peter.kirme...@ts.fujitsu.com >> Sent: Thursday, July 07, 2016 4:13 PM >> To: edk2-devel@lists.01.org >> Subject: [edk2] Build fails due to missing NASM >> >> Hello, >> >> I just updated our local edk2 fork and there were a lot of new .nasm >> files added. >> Unfortunately this update was not compiling any more. >> The reason is that we don't have the tool NASM installed. >> I got it back working again by installing NASM but what I want to >> mention >> here: >> >> I was missing either >> an update of any README telling me that NASM is now required or >> an update of the build tools that have NASM integrated or >> support for backward compatibility (a way avoiding NASM installation). >> >> If none of them is preset, failing builds are pre-programmed for >> anyone who wasn't aware of the tool change and doesn't have NASM installed. >> >> Best Regards, >> Peter >> >> --- >> Peter Kirmeier >> Senior Firmware Developer >> Client Computing Devices Engineering >> [logo] >> FUJITSU >> Buergermeister-Ulrich-Strasse 100, 86199 Augsburg, Germany >> Tel.: +49 (821) 804 3227 >> Fax: +49 (821) 804 83227 >> E-mail: >> peter.kirme...@ts.fujitsu.com<mailto:peter.kirme...@ts.fujitsu.com> >> Web: ts.fujitsu.com<http://ts.fujitsu.com/> >> Company: Fujitsu Technology Solutions GmbH / >> ts.fujitsu.com/imprint<http://ts.fujitsu.com/imprint.html> >> _______________________________________________ >> edk2-devel mailing list >> edk2-devel@lists.01.org >> https://lists.01.org/mailman/listinfo/edk2-devel > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel > _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
