Hi Laszlo, I agree that being on this list helps a lot in different ways.
In my opinion the main benefit of a mailing lists is the room for discussion. Results of discussions should then be placed into the documentation. So further on, no one have to read the discussion in the archive again because he will find (or him will be shown) the documentation with the result. Same when mailing lists are used for patches... It is no good design when someone asks you something and the answer is: "Oh boy, you haven't looked at the 2 billion mails archive as I wrote this 2 years ago". I mean: Such things should be noted at the source code and/or documentation, so referring the archive is no good solution. (PS: I know you don't mean it like that, so don't take this statement personally) Unfortunately lots of people are tending to ask anyone before reading some documents for a few minutes or hitting the search button at least once on a web search engine. But this should be no reason to make documentations less important. In conclusion: Liming is going to fix my "NASM" issue and I'm totally fine with that :) Thank you. Best Regards, Peter -----Original Message----- From: Laszlo Ersek [mailto:[email protected]] Sent: Thursday, July 07, 2016 11:29 AM To: Kirmeier, Peter; Gao, Liming; [email protected] Subject: Re: [edk2] Build fails due to missing NASM On 07/07/16 11:08, [email protected] 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:[email protected]] > Sent: Thursday, July 07, 2016 10:49 AM > To: Kirmeier, Peter; [email protected] > 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:[email protected]] On Behalf >> Of [email protected] >> Sent: Thursday, July 07, 2016 4:13 PM >> To: [email protected] >> 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: >> [email protected]<mailto:[email protected]> >> 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 >> [email protected] >> https://lists.01.org/mailman/listinfo/edk2-devel > _______________________________________________ > edk2-devel mailing list > [email protected] > https://lists.01.org/mailman/listinfo/edk2-devel > _______________________________________________ edk2-devel mailing list [email protected] https://lists.01.org/mailman/listinfo/edk2-devel
