> On 10 Feb 2018, at 10:48, Torsten Bögershausen <tboegi@xxxxxx> wrote:
>
> On Fri, Feb 09, 2018 at 02:28:28PM +0100, lars.schneider@xxxxxxxxxxxx wrote:
>> From: Lars Schneider <larsxschneider@xxxxxxxxx>
>>
>> ...
>>
>> +Please note that using the `working-tree-encoding` attribute may have a
>> +number of pitfalls:
>> +
>> +- Git clients that do not support the `working-tree-encoding` attribute
>
> A client to Git ?
> Or may be "third party Git implementations"
OK, I'll go with "Third party Git implementations".
>>
>> +As an example, use the following attributes if your '*.proj' files are
>> +UTF-16 encoded with byte order mark (BOM) and you want Git to perform
>> +automatic line ending conversion based on your platform.
>> +
>> +------------------------
>> +*.proj text working-tree-encoding=UTF-16
>> +------------------------
>> +
>> +Use the following attributes if your '*.proj' files are UTF-16 little
>> +endian encoded without BOM and you want Git to use Windows line endings
>> +in the working directory. Please note, it is highly recommended to
>> +explicitly define the line endings with `eol` if the `working-tree-encoding`
>> +attribute is used to avoid ambiguity.
>> +
>> +------------------------
>> +*.proj working-tree-encoding=UTF-16LE text eol=CRLF
>> +------------------------
>> +
>> +You can get a list of all available encodings on your platform with the
>> +following command:
>
> One question:
> +*.proj text working-tree-encoding=UTF-16
> vs
> *.proj working-tree-encoding=UTF-16LE text eol=CRLF
>
> Technically the order of attributes doesn't matter, but that is not what we
> want to demonstrate here and now.
> I would probably move the "text" attribute to the end of the line.
> So that readers don't start to wonder if the order is important.
I agree in general. However, I would move "text" to the beginning to be
consistent with the gitattribute pattern above. OK?
>>
>> + if (has_prohibited_utf_bom(enc->name, src, src_len)) {
>> + const char *error_msg = _(
>> + "BOM is prohibited for '%s' if encoded as %s");
>> + const char *advise_msg = _(
>> + "You told Git to treat '%s' as %s. A byte order mark "
>> + "(BOM) is prohibited with this encoding. Either use "
>> + "%.6s as working tree encoding or remove the BOM from the "
>> + "file.");
>
> "You told Git" is probly right from Gits point of view, and advises are really helpfull.
> But what should the user do about it ?
> Could we give a better advise ?
>
>
> "A byte order mark (BOM) is prohibited with %s.
> Please remove the BOM from the file %s
> or use "%s as working-tree-encoding"
>
> I would probably suspect that a tool wrote the BOM, and that is
> good and can or should not be changed by a user.
>
> So a simply message like this could be the preferred (and only)
> solution for a user:
> "A byte order mark (BOM) is prohibited with %s.
> Please use "%s as working-tree-encoding"
OK. I like the last one!
> (And why %.6s and not simply %s ?)
The encodings is UTF-16LE, UTF-16BE, UTF-32LE, or UTF-32BE.
I just use the first 6 characters to print the encoding that
allows BOMs (UTF-16 or UTF-32). I'll add a comment to explain
the trickery in the code!
Thanks,
Lars
