Re: [edk2-devel] [PATCH] BaseTools/Scripts: Add sendemail.transferEncoding to SetupGit.py

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

Hi Nate,

On 12/18/19 4:01 AM, Nate DeSimone wrote:
> Any chance I could get a code review on this?
> 
> Thanks,
> Nate
> 
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Nate DeSimone
> Sent: Friday, December 6, 2019 10:15 AM
> To: devel@edk2.groups.io
> Cc: Feng, Bob C <bob.c.feng@intel.com>; Gao, Liming <liming.gao@intel.com>; Leif Lindholm <leif.lindholm@linaro.org>
> Subject: [edk2-devel] [PATCH] BaseTools/Scripts: Add sendemail.transferEncoding to SetupGit.py
> 
> If git finds a '\r' character in the message, then it converts the entire message content into Quoted-Printable encoding. It appears that when groups.io converts the QP encoding back to text format, the '\r' characters somehow become '\n'. To workaround this, the SetupGit.py script will now explicitly set the sendemail.transferEncoding git config option to '8bit'
> 
> Cc: Bob Feng <bob.c.feng@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Signed-off-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
> ---
>   BaseTools/Scripts/SetupGit.py | 38 ++++++++++++++++++-----------------
>   1 file changed, 20 insertions(+), 18 deletions(-)
> 
> diff --git a/BaseTools/Scripts/SetupGit.py b/BaseTools/Scripts/SetupGit.py index 3d39d3b35f..514f1c4d42 100644
> --- a/BaseTools/Scripts/SetupGit.py
> +++ b/BaseTools/Scripts/SetupGit.py
> @@ -2,6 +2,7 @@
>   #  Set up the git configuration for contributing to TianoCore projects  #  #  Copyright (c) 2019, Linaro Ltd. All rights reserved.<BR>
> +#  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
>   #
>   #  SPDX-License-Identifier: BSD-2-Clause-Patent  # @@ -53,29 +54,30 @@ MIN_GIT_VERSION = (1, 9, 0)
>   
>   # Set of options to be set identically for all repositories  OPTIONS = [
> -    {'section': 'am',          'option': 'keepcr',         'value': True},
> -    {'section': 'am',          'option': 'signoff',        'value': True},
> -    {'section': 'cherry-pick', 'option': 'signoff',        'value': True},
> -    {'section': 'color',       'option': 'diff',           'value': True},
> -    {'section': 'color',       'option': 'grep',           'value': 'auto'},
> -    {'section': 'commit',      'option': 'signoff',        'value': True},
> -    {'section': 'core',        'option': 'abbrev',         'value': 12},
> +    {'section': 'am',          'option': 'keepcr',            'value': True},
> +    {'section': 'am',          'option': 'signoff',           'value': True},
> +    {'section': 'cherry-pick', 'option': 'signoff',           'value': True},
> +    {'section': 'color',       'option': 'diff',              'value': True},
> +    {'section': 'color',       'option': 'grep',              'value': 'auto'},
> +    {'section': 'commit',      'option': 'signoff',           'value': True},
> +    {'section': 'core',        'option': 'abbrev',            'value': 12},
>       {'section': 'core',        'option': 'attributesFile',
>        'value': os.path.join(CONFDIR, 'gitattributes').replace('\\', '/')},
> -    {'section': 'core',        'option': 'whitespace',     'value': 'cr-at-eol'},
> -    {'section': 'diff',        'option': 'algorithm',      'value': 'patience'},
> +    {'section': 'core',        'option': 'whitespace',        'value': 'cr-at-eol'},
> +    {'section': 'diff',        'option': 'algorithm',         'value': 'patience'},
>       {'section': 'diff',        'option': 'orderFile',
>        'value': os.path.join(CONFDIR, 'diff.order').replace('\\', '/')},
> -    {'section': 'diff',        'option': 'renames',        'value': 'copies'},
> -    {'section': 'diff',        'option': 'statGraphWidth', 'value': '20'},
> -    {'section': 'diff "ini"',    'option': 'xfuncname',
> +    {'section': 'diff',        'option': 'renames',           'value': 'copies'},
> +    {'section': 'diff',        'option': 'statGraphWidth',    'value': '20'},
> +    {'section': 'diff "ini"',  'option': 'xfuncname',
>        'value': '^\\\\[[A-Za-z0-9_., ]+]'},
> -    {'section': 'format',      'option': 'coverLetter',    'value': True},
> -    {'section': 'format',      'option': 'numbered',       'value': True},
> -    {'section': 'format',      'option': 'signoff',        'value': False},
> -    {'section': 'notes',       'option': 'rewriteRef',     'value': 'refs/notes/commits'},
> -    {'section': 'sendemail',   'option': 'chainreplyto',   'value': False},
> -    {'section': 'sendemail',   'option': 'thread',         'value': True},
> +    {'section': 'format',      'option': 'coverLetter',       'value': True},
> +    {'section': 'format',      'option': 'numbered',          'value': True},
> +    {'section': 'format',      'option': 'signoff',           'value': False},
> +    {'section': 'notes',       'option': 'rewriteRef',        'value': 'refs/notes/commits'},
> +    {'section': 'sendemail',   'option': 'chainreplyto',      'value': False},
> +    {'section': 'sendemail',   'option': 'thread',            'value': True},
> +    {'section': 'sendemail',   'option': 'transferEncoding',  'value': '8bit'},

Unfortunately I never received the original patch.
I downloaded it from 
https://www.redhat.com/archives/edk2-devel-archive/2019-December/msg00720.html 
but I get an error when applying:

**** malformed patch at line 12: -    {'section': 'am', 
'option': 'signoff',        'value': True},

Due to space/tab? changes, your patch is very hard to review (I wanted 
to look at it with 'git-diff --word-diff=color'. If I missed anything, 
you simply added:

+    {'section': 'sendemail',   'option': 'transferEncoding',  'value': 
'8bit'},

Is that right?

>       ]
>   
>   
> --
> 2.24.0.windows.2
> 
> 
> 
> 
> 
> 
>