From: Lars Schneider <larsxschneider@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Lars Schneider" <lars.schneider@autodesk.com>,
git <git@vger.kernel.org>, "Torsten Bögershausen" <tboegi@web.de>,
"Johannes Sixt" <j6t@kdbg.org>,
sunshine@sunshineco.com, peff@peff.net,
ramsay@ramsayjones.plus.com, Johannes.Schindelin@gmx.de
Subject: Re: [PATCH v10 7/9] convert: check for detectable errors in UTF encodings
Date: Wed, 7 Mar 2018 23:12:38 +0100 [thread overview]
Message-ID: <B001E8E2-9C98-4136-87A3-4425C50E90DB@gmail.com> (raw)
In-Reply-To: <xmqqr2ovzmwo.fsf@gitster-ct.c.googlers.com>
> On 07 Mar 2018, at 20:49, Junio C Hamano <gitster@pobox.com> wrote:
>
> lars.schneider@autodesk.com writes:
>
>> +static int validate_encoding(const char *path, const char *enc,
>> + const char *data, size_t len, int die_on_error)
>> +{
>> + /* We only check for UTF here as UTF?? can be an alias for UTF-?? */
>> + if (startscase_with(enc, "UTF")) {
>> + /*
>> + * Check for detectable errors in UTF encodings
>> + */
>> + if (has_prohibited_utf_bom(enc, data, len)) {
>> + const char *error_msg = _(
>> + "BOM is prohibited in '%s' if encoded as %s");
>> + /*
>> + * This advice is shown for UTF-??BE and UTF-??LE encodings.
>> + * We cut off the last two characters of the encoding name
>> + # to generate the encoding name suitable for BOMs.
>> + */
>
> Yuck. The code pretends to abstract away the details in a helper
> has_prohibited_x() yet the caller still knows quite a lot.
True, but has_prohibited_x() cannot create a proper error/advise
message unless we give it more parameters (e.g. path name).
Therefore, I don't see a better way right now.
>> + const char *advise_msg = _(
>> + "The file '%s' contains a byte order "
>> + "mark (BOM). Please use %s as "
>> + "working-tree-encoding.");
>> + char *upper_enc = xstrdup_toupper(enc);
>> + upper_enc[strlen(upper_enc)-2] = '\0';
>> + advise(advise_msg, path, upper_enc);
>> + free(upper_enc);
>
> I think this up-casing is more problematic than without, not from
> the point of view of the internal code, but from the point of view
> of the end user experience. When the user writes utf16le or
> utf-16le and the data does not trigger the BOM check, we are likely
> to successfully convert it. I do not see the merit of suggesting
> UTF16 or UTF-16 in such a case, over telling them to just drop the
> byte-order suffix from the encoding names (i.e. utf16 or utf-16).
>
> If you are trying to force/nudge people in the direction of
> canonical way of spelling things (which may not be a bad idea), then
> "utf16le" as the original input would want to result in "UTF-16"
> with dash in the advise, no?
Correct. In the error messages I kept the encoding name "as-is" and
only in the advise message I used the uppercase variant to steer
people into the canonical direction. My initial reason for this was
that in is_missing_required_utf_bom() we add "BE/LE" to the encoding
in the advise message. Let's say the user used "Utf-16" as encoding.
Should "BE/LE" be upper case or lower case? To avoid that question
I made it always upper case.
I also would have liked to advise "UTF-16" instead of "UTF16" as
you suggested. However, that required a few more lines and I wanted
to keep the change to a minimum. I feel this could be added in a
follow up patch.
> On the other hand, if we are not enforcing such a policy decision
> but merely explaining a way to work around this check, then it may
> be better to give a variant with the smaller difference from the
> original (i.e. without up-casing).
See example mentioned above: "Utf-16". How would you handle that?
Thanks,
Lars
next prev parent reply other threads:[~2018-03-07 22:12 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-07 17:30 [PATCH v10 0/9] convert: add support for different encodings lars.schneider
2018-03-07 17:30 ` [PATCH v10 1/9] strbuf: remove unnecessary NUL assignment in xstrdup_tolower() lars.schneider
2018-03-07 17:30 ` [PATCH v10 2/9] strbuf: add xstrdup_toupper() lars.schneider
2018-03-07 17:30 ` [PATCH v10 3/9] strbuf: add a case insensitive starts_with() lars.schneider
2018-03-08 0:31 ` Duy Nguyen
2018-03-08 23:12 ` Junio C Hamano
2018-03-09 15:54 ` Lars Schneider
2018-03-09 17:20 ` Junio C Hamano
2018-03-09 19:06 ` Ævar Arnfjörð Bjarmason
2018-03-07 17:30 ` [PATCH v10 4/9] utf8: add function to detect prohibited UTF-16/32 BOM lars.schneider
2018-03-07 17:30 ` [PATCH v10 5/9] utf8: add function to detect a missing " lars.schneider
2018-03-07 17:30 ` [PATCH v10 6/9] convert: add 'working-tree-encoding' attribute lars.schneider
2018-03-07 17:54 ` Eric Sunshine
2018-03-07 22:56 ` Lars Schneider
2018-03-07 22:57 ` Junio C Hamano
2018-03-07 19:35 ` Junio C Hamano
2018-03-07 17:30 ` [PATCH v10 7/9] convert: check for detectable errors in UTF encodings lars.schneider
2018-03-07 18:04 ` Eric Sunshine
2018-03-09 17:02 ` Lars Schneider
2018-03-07 19:49 ` Junio C Hamano
2018-03-07 22:12 ` Lars Schneider [this message]
2018-03-07 22:32 ` Junio C Hamano
2018-03-07 22:49 ` Lars Schneider
2018-03-07 22:57 ` Junio C Hamano
2018-03-07 23:19 ` Lars Schneider
2018-03-07 23:34 ` Junio C Hamano
2018-03-07 17:30 ` [PATCH v10 8/9] convert: add tracing for 'working-tree-encoding' attribute lars.schneider
2018-03-07 17:30 ` [PATCH v10 9/9] convert: add round trip check based on 'core.checkRoundtripEncoding' lars.schneider
2018-03-07 19:59 ` Junio C Hamano
2018-03-07 22:44 ` Lars Schneider
2018-03-07 22:52 ` Junio C Hamano
2018-03-07 22:58 ` Lars Schneider
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B001E8E2-9C98-4136-87A3-4425C50E90DB@gmail.com \
--to=larsxschneider@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=j6t@kdbg.org \
--cc=lars.schneider@autodesk.com \
--cc=peff@peff.net \
--cc=ramsay@ramsayjones.plus.com \
--cc=sunshine@sunshineco.com \
--cc=tboegi@web.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).