From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id C829A2095C6AB for ; Wed, 26 Apr 2017 11:46:52 -0700 (PDT) Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Apr 2017 11:46:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.37,255,1488873600"; d="scan'208";a="1123795589" Received: from orsmsx105.amr.corp.intel.com ([10.22.225.132]) by orsmga001.jf.intel.com with ESMTP; 26 Apr 2017 11:46:52 -0700 Received: from orsmsx113.amr.corp.intel.com ([169.254.9.59]) by ORSMSX105.amr.corp.intel.com ([169.254.2.29]) with mapi id 14.03.0319.002; Wed, 26 Apr 2017 11:46:52 -0700 From: "Kinney, Michael D" To: Tim Lewis , "edk2-devel@lists.01.org" , "Kinney, Michael D" CC: "Carsey, Jaben" , "Shaw, Kevin W" Thread-Topic: [edk2] [edk2-UniSpecification PATCH] Allow .uni files on disk to be UTF-8 without a BOM Thread-Index: AQHSvimGOHKniHBBck6SNVtE4IZySaHXS+yAgAD9tQD//59LUIAAh4iA//+MdrA= Date: Wed, 26 Apr 2017 18:46:51 +0000 Message-ID: References: <1493168839-11708-1-git-send-email-michael.d.kinney@intel.com> <1493168839-11708-2-git-send-email-michael.d.kinney@intel.com> <7236196A5DF6C040855A6D96F556A53F576347@msmail.insydesw.com.tw> <7236196A5DF6C040855A6D96F556A53F576544@msmail.insydesw.com.tw> In-Reply-To: <7236196A5DF6C040855A6D96F556A53F576544@msmail.insydesw.com.tw> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNTlhZjEzMzUtMDA2NC00NGIwLTg3NDUtNGEyZWZmM2JiNDcxIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IjVNOTBNUzRWaEMyODJiaHRwK3JxRjdkdkZZMlwvRXoyemtvc3hjRmV0azhrPSJ9 dlp-product: dlpe-windows dlp-version: 10.0.102.7 dlp-reaction: no-action x-originating-ip: [10.22.254.139] MIME-Version: 1.0 Subject: Re: [edk2-UniSpecification PATCH] Allow .uni files on disk to be UTF-8 without a BOM X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 26 Apr 2017 18:46:53 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Tim, If you look at the entire file history of the EDK II, you will see=20 that the BOM has always been present in the UTF-16LE formatted files. The build tools were updated in 2015 to *add* support for UTF-8 file. The .uni files in the EDK II project were then converted from UTF-16LE with a BOM to UTF-8 without a BOM. This provided an easier developer experience when using GIT to do email patch review of .uni files. It is possible I am missing something here. Can you please provide=20 a pointer to the EDK II commit(s) where BOMs were added to UTF-16LE=20 .uni files. Thanks, Mike > -----Original Message----- > From: Tim Lewis [mailto:tim.lewis@insyde.com] > Sent: Wednesday, April 26, 2017 11:34 AM > To: Kinney, Michael D ; edk2-devel@lists.01.o= rg > Cc: Carsey, Jaben ; Shaw, Kevin W > > Subject: RE: [edk2] [edk2-UniSpecification PATCH] Allow .uni files on dis= k to be > UTF-8 without a BOM >=20 > Mike -- >=20 > I understand that EDK2 has decided to add BOM markers two years ago. Addi= ng a BOM > didn't change the default. The problem is (a) there are still hundreds of= files > extant in our codebase which were created prior to the 2015 changes and s= till in > use, and (b) this change is not backward compatible for these files. >=20 > Tim >=20 > -----Original Message----- > From: Kinney, Michael D [mailto:michael.d.kinney@intel.com] > Sent: Wednesday, April 26, 2017 11:11 AM > To: Tim Lewis ; edk2-devel@lists.01.org; Kinney, Mi= chael D > > Cc: Carsey, Jaben ; Shaw, Kevin W > > Subject: RE: [edk2] [edk2-UniSpecification PATCH] Allow .uni files on dis= k to be > UTF-8 without a BOM >=20 > Hi Tim, >=20 > This is not a request for a new change. Instead, the intent of this docu= ment > change is to update the document to reflect the implemented behavior of t= he EDK > II tools. The EDK II tool updates to add UTF-8 file support were complet= ed with > the patches listed below. Notice that the main one for normal build supp= ort was > checked in almost 2 years ago. >=20 > BaseTools - UniClassObject - 6/23/2015 > * > https://github.com/tianocore/edk2/commit/d80e451b187c9d33cbd771253fbd5119= 670f75c6 > * > https://github.com/tianocore/edk2/commit/be264422c95c781a345978f17b7e80b9= 1f816eda >=20 > BaseTools - ECC - 12/29/2015 > * > https://github.com/tianocore/edk2/commit/975889279df2eb3d3338cb88afb3faa7= 1ddde4d6 >=20 > BaseTools - UPT - 4/25/2016 > * > https://github.com/tianocore/edk2/commit/4a21fb3b67a0ef1655b43e9368b6b697= bbf327af >=20 > This was intended to be a 100% backwards compatible change. >=20 > All .uni files in the EDK II project in UTF-16LE format have always use a= BOM. > Please checkout UDK2015 or older UDKs and you will see all .uni files sta= rt with > 0xff 0xfe. >=20 > Thanks, >=20 > Mike >=20 > > -----Original Message----- > > From: Tim Lewis [mailto:tim.lewis@insyde.com] > > Sent: Wednesday, April 26, 2017 9:15 AM > > To: Kinney, Michael D ; > > edk2-devel@lists.01.org > > Cc: Carsey, Jaben ; Shaw, Kevin W > > > > Subject: RE: [edk2] [edk2-UniSpecification PATCH] Allow .uni files on > > disk to be > > UTF-8 without a BOM > > > > Mike -- > > > > This breaks our existing build tools, which assume that a file without > > a BOM is UTF-16. > > > > Tim > > > > -----Original Message----- > > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of > > Michael Kinney > > Sent: Tuesday, April 25, 2017 6:07 PM > > To: edk2-devel@lists.01.org > > Cc: Jaben Carsey ; Kevin W Shaw > > > > Subject: [edk2] [edk2-UniSpecification PATCH] Allow .uni files on disk > > to be UTF- > > 8 without a BOM > > > > https://bugzilla.tianocore.org/show_bug.cgi?id=3D507 > > > > Cc: Jaben Carsey > > Cc: Yonghong Zhu > > Cc: Kevin W Shaw > > Contributed-under: TianoCore Contribution Agreement 1.1 > > Signed-off-by: Michael Kinney > > --- > > 2_unicode_strings_file_format.md | 9 ++++++--- > > README.md | 27 ++++++++++++++------------- > > 2 files changed, 20 insertions(+), 16 deletions(-) > > > > diff --git a/2_unicode_strings_file_format.md > > b/2_unicode_strings_file_format.md > > index 0150c85..7a4a019 100644 > > --- a/2_unicode_strings_file_format.md > > +++ b/2_unicode_strings_file_format.md > > @@ -33,7 +33,8 @@ > > > > EDK II Unicode files are used for mapping token names to localized > > strings that are identified by an RFC4646 language code. The format > > for storing EDK II - Unicode files is UTF-16LE. The character content m= ust be > UCS-2. > > +Unicode files on disk is UTF-8 (without a BOM character) or UTF-16LE > > +(with a BOM character). The character content must be UCS-2. > > > > Strings ends are determined by the first of the following items found: > > > > @@ -44,11 +45,13 @@ Strings ends are determined by the first of the > > following items found: > > > > Comments may appear anywhere within the string file. > > > > -All the files must begin with a Unicode BOM character. > > +All UTF-16LE files must begin with a Unicode BOM character. > > +All UTF-8 files must not begin with a Unicode BOM character. > > > > ********** > > **NOTE:** Please make sure you select an editor that supports UCS-2 > > characters - that can be stored in a UTF-16LE file. > > +that can be stored in either a UTF-8 (without a BOM character) or a > > +UTF-16LE file (with a BOM character). > > ********** > > > > ## 2.1 Common EBNF > > diff --git a/README.md b/README.md > > index 63842a1..015aef1 100644 > > --- a/README.md > > +++ b/README.md > > @@ -77,16 +77,17 @@ Copyright (c) 2016-2017, Intel Corporation. All > > rights reserved. > > > > ### Revision History > > > > -| Revision | Description > > | Date | > > -| ----------------- | > > -| ---------------------------------------------------------- > > ------------------------------ | --------------- | > > -| 1.0 | Initial Release. > > | February 2014 | > > -| 1.1 | Updated EBNF to follow syntax specified in EBNF = by the > > ANTLR project. | August 2014 | > > -| | Added content related to EDK II Meta-Data Unicod= e files. > > | | > > -| | Restructured document. > > | | > > -| | Removed security and C format GUID definitions, > > -| not > > required for HII or other UNI files. | | > > -| | Removed invalid escape code sequences. > > | | > > -| 1.2 | Added optional font formatting > > | September 2014 | > > -| 1.2 Errata A | Correct misspelling of: `STR_PROPERTIES_MODULE_N= AME` > > | April 2015 | > > -| 1.3 | Added: Syntax for non-ascii characters inside qu= oted > > strings. | March 2016 | > > -| | Removed: Info on specific consumers (.INF & .DEC= ) > removed. > > | | > > -| 1.4 | Convert to GitBook format > > | March 2017 | > > +| Revision | Description > > | Date | > > +| ----------------- | > > +| ---------------------------------------------------------- > > ------------------------------------------------------------ | > > --------------- | > > +| 1.0 | Initial Release. > > | February 2014 | > > +| 1.1 | Updated EBNF to follow syntax specified in EBNF = by the > > ANTLR project. | Augus= t 2014 > > | > > +| | Added content related to EDK II Meta-Data Unicod= e files. > > | | > > +| | Restructured document. > > | | > > +| | Removed security and C format GUID definitions, > > +| not > > required for HII or other UNI files. | > > | > > +| | Removed invalid escape code sequences. > > | | > > +| 1.2 | Added optional font formatting > > | September 2014 | > > +| 1.2 Errata A | Correct misspelling of: `STR_PROPERTIES_MODULE_N= AME` > > | April 2015 | > > +| 1.3 | Added: Syntax for non-ascii characters inside qu= oted > > strings. | Mar= ch 2016 > > | > > +| | Removed: Info on specific consumers (.INF & .DEC= ) > removed. > > | | > > +| 1.4 | Convert to GitBook format > > | April 2017 | > > +| | > > +| [#507](https://bugzilla.tianocore.org/show_bug.cgi?id=3D507) > > UNI Spec: Clarify that .uni files maybe UTF-8 without a BOM | = | > > -- > > 2.6.3.windows.1 > > > > _______________________________________________ > > edk2-devel mailing list > > edk2-devel@lists.01.org > > https://lists.01.org/mailman/listinfo/edk2-devel