From: "Krzysztof Żelechowski" <giecrilj@stegny.2a.pl>
To: Junio C Hamano <gitster@pobox.com>
Cc: Christopher Yeleighton via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, Bagas Sanjaya <bagasdotme@gmail.com>,
Christopher Yeleighton <ne01026@shark.2a.pl>
Subject: Re: [PATCH v2] pretty-options.txt: describe supported encoding
Date: Sat, 28 Aug 2021 01:20:53 +0200 [thread overview]
Message-ID: <1659256.Cefek1SpHl@localhost.localdomain> (raw)
In-Reply-To: <xmqq5yvqbz0j.fsf@gitster.g>
Dnia piątek, 27 sierpnia 2021 19:03:56 CEST Junio C Hamano pisze:
> > + The encoding must be a system encoding supported by iconv(1),
> > + otherwise this option will be ignored.
> > + POSIX character maps used by iconv(1p) are not supported.
>
> This paragraph is a bit hard to grok.
>
> I think it is saying that the "-f frommap -t tomap" form in [*1*]
> that can use arbitrary character set description file is not
> supported, but "-f fromcode -t tocode" form, which also is what
> iconv_open() takes [*2*], is supported. Am I reading it correctly?
Yes
>
> Is there an easier-to-read way to explain the distinction to our
> average reader?
It is not our job to explain what POSIX character maps are. The takeaway is
they are unsupported; if you do not know what they are, why should you bother?
>
> What I am getting at is this. Imagine average users who need to see
> their commits recoded to iso-8859-2. They see "git log" has
> "--encoding=<encoding>" option, read the above paragraph and wonder
> if they are on the supported side or unsupported side of the above
> paragraph. I want to make it easy for them to stop wondering.
>
> For that purpose, "iconv(1) vs iconv(1p)" would not help them very
> much, especially considering that not all Git users are UNIX users
> (they probably do not even know what (1) and (1p) means).
I am sorry, as a UNIX user I have no idea what iconv, being part of the GNU C
library, means and how it works on a non-UNIX system that does not contain
one. If you know, could you enlighten us please?
> I think our end-user facing manual pages tend to avoid the latter.
> We do use "shall" in the RFC2119/BCP14 sense on the technical side
> of our documentation where we give requirements to the third-party
> implementations so that they can interoperate with us, but this is
> not such a description.
>
> Thanks.
I shall revert it after we have come to an agreement about the POSIX stuff.
BR,
Chris
prev parent reply other threads:[~2021-08-27 23:21 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-26 21:34 [PATCH] pretty-options.txt: describe supported encoding Christopher Yeleighton via GitGitGadget
2021-08-27 10:46 ` Bagas Sanjaya
2021-08-27 11:47 ` Krzysztof Żelechowski
2021-08-27 11:51 ` [PATCH v2] " Krzysztof Żelechowski
2021-08-27 17:03 ` Junio C Hamano
2021-08-27 18:03 ` Jeff King
2021-08-27 23:20 ` Krzysztof Żelechowski [this message]
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=1659256.Cefek1SpHl@localhost.localdomain \
--to=giecrilj@stegny.2a.pl \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=ne01026@shark.2a.pl \
/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).