diff mbox series

Make sure INSTALL is plaintext

Message ID 20230629132423.84902-1-siddhesh@sourceware.org
State New
Headers show
Series Make sure INSTALL is plaintext | expand

Commit Message

Siddhesh Poyarekar June 29, 2023, 1:24 p.m. UTC
Add --disable-encoding to makeinfo flags so that it does not generate
quote glyphs.

Signed-off-by: Siddhesh Poyarekar <siddhesh@sourceware.org>
---

It's a trivial fixup, so I'll push this shortly if there are no
objections.

 INSTALL  | 4 ++--
 Makefile | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

Comments

Andreas Schwab June 29, 2023, 1:33 p.m. UTC | #1
On Jun 29 2023, Siddhesh Poyarekar via Libc-alpha wrote:

> diff --git a/INSTALL b/INSTALL
> index 6d51475536..f921f82b4c 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -469,8 +469,8 @@ build the GNU C Library:
>  
>     * GNU 'make' 4.0 or newer
>  
> -     As of release time, GNU 'make' 4.4 is the newest verified to work to
> -     build the GNU C Library.
> +     As of release time, GNU 'make' 4.4 is the newest verified to work
> +     to build the GNU C Library.

The only difference I see is whitespace.
Siddhesh Poyarekar June 29, 2023, 1:37 p.m. UTC | #2
On 2023-06-29 09:33, Andreas Schwab wrote:
> On Jun 29 2023, Siddhesh Poyarekar via Libc-alpha wrote:
> 
>> diff --git a/INSTALL b/INSTALL
>> index 6d51475536..f921f82b4c 100644
>> --- a/INSTALL
>> +++ b/INSTALL
>> @@ -469,8 +469,8 @@ build the GNU C Library:
>>   
>>      * GNU 'make' 4.0 or newer
>>   
>> -     As of release time, GNU 'make' 4.4 is the newest verified to work to
>> -     build the GNU C Library.
>> +     As of release time, GNU 'make' 4.4 is the newest verified to work
>> +     to build the GNU C Library.
> 
> The only difference I see is whitespace.
> 

Without --disable-encoding, makeinfo 7.0.2 produces unicode quotation 
marks (‘ ’) all across INSTALL.  The Makefile change to add 
--disable-encoding avoids that.

Sid
Andreas Schwab June 29, 2023, 1:45 p.m. UTC | #3
On Jun 29 2023, Siddhesh Poyarekar wrote:

> On 2023-06-29 09:33, Andreas Schwab wrote:
>> On Jun 29 2023, Siddhesh Poyarekar via Libc-alpha wrote:
>> 
>>> diff --git a/INSTALL b/INSTALL
>>> index 6d51475536..f921f82b4c 100644
>>> --- a/INSTALL
>>> +++ b/INSTALL
>>> @@ -469,8 +469,8 @@ build the GNU C Library:
>>>        * GNU 'make' 4.0 or newer
>>>   -     As of release time, GNU 'make' 4.4 is the newest verified to
>>> work to
>>> -     build the GNU C Library.
>>> +     As of release time, GNU 'make' 4.4 is the newest verified to work
>>> +     to build the GNU C Library.
>> The only difference I see is whitespace.
>> 
>
> Without --disable-encoding, makeinfo 7.0.2 produces unicode quotation
> marks (‘ ’) all across INSTALL.

That's still plain text.
Siddhesh Poyarekar June 29, 2023, 1:48 p.m. UTC | #4
On 2023-06-29 09:45, Andreas Schwab wrote:
> On Jun 29 2023, Siddhesh Poyarekar wrote:
> 
>> On 2023-06-29 09:33, Andreas Schwab wrote:
>>> On Jun 29 2023, Siddhesh Poyarekar via Libc-alpha wrote:
>>>
>>>> diff --git a/INSTALL b/INSTALL
>>>> index 6d51475536..f921f82b4c 100644
>>>> --- a/INSTALL
>>>> +++ b/INSTALL
>>>> @@ -469,8 +469,8 @@ build the GNU C Library:
>>>>         * GNU 'make' 4.0 or newer
>>>>    -     As of release time, GNU 'make' 4.4 is the newest verified to
>>>> work to
>>>> -     build the GNU C Library.
>>>> +     As of release time, GNU 'make' 4.4 is the newest verified to work
>>>> +     to build the GNU C Library.
>>> The only difference I see is whitespace.
>>>
>>
>> Without --disable-encoding, makeinfo 7.0.2 produces unicode quotation
>> marks (‘ ’) all across INSTALL.
> 
> That's still plain text.
> 

Alternatively I could just regenerate and push INSTALL with the updated 
quotation marks, would you prefer that?

Basically I'm about to propose some flag changes that will end up 
regenerating INSTALL and I was looking to keep that diff minimal.

Sid
Siddhesh Poyarekar June 29, 2023, 2:55 p.m. UTC | #5
On 2023-06-29 09:48, Siddhesh Poyarekar via Libc-alpha wrote:
> On 2023-06-29 09:45, Andreas Schwab wrote:
>> On Jun 29 2023, Siddhesh Poyarekar wrote:
>>
>>> On 2023-06-29 09:33, Andreas Schwab wrote:
>>>> On Jun 29 2023, Siddhesh Poyarekar via Libc-alpha wrote:
>>>>
>>>>> diff --git a/INSTALL b/INSTALL
>>>>> index 6d51475536..f921f82b4c 100644
>>>>> --- a/INSTALL
>>>>> +++ b/INSTALL
>>>>> @@ -469,8 +469,8 @@ build the GNU C Library:
>>>>>         * GNU 'make' 4.0 or newer
>>>>>    -     As of release time, GNU 'make' 4.4 is the newest verified to
>>>>> work to
>>>>> -     build the GNU C Library.
>>>>> +     As of release time, GNU 'make' 4.4 is the newest verified to 
>>>>> work
>>>>> +     to build the GNU C Library.
>>>> The only difference I see is whitespace.
>>>>
>>>
>>> Without --disable-encoding, makeinfo 7.0.2 produces unicode quotation
>>> marks (‘ ’) all across INSTALL.
>>
>> That's still plain text.
>>
> 
> Alternatively I could just regenerate and push INSTALL with the updated 
> quotation marks, would you prefer that?

Another alternative, change subject line to "Make sure INSTALL is ASCII 
plaintext".  What do you prefer?

Thanks,
Sid
Andreas Schwab June 29, 2023, 3:05 p.m. UTC | #6
I prefer an accurate description.
Siddhesh Poyarekar June 29, 2023, 3:09 p.m. UTC | #7
On 2023-06-29 11:05, Andreas Schwab wrote:
> I prefer an accurate description.
> 

OK, pushed with this description:

"""
Make sure INSTALL is ASCII plaintext

Add --disable-encoding to makeinfo flags so that it does not generate
unicode quote glyphs.
"""
Paul Eggert June 29, 2023, 4:32 p.m. UTC | #8
On 2023-06-29 06:48, Siddhesh Poyarekar via Libc-alpha wrote:
> Alternatively I could just regenerate and push INSTALL with the updated 
> quotation marks, would you prefer that?

I’d prefer that, yes. Gnulib switched INSTALL from ASCII to UTF-8 in 
January, mimicking the planned next Autoconf release, and it’s worked 
fine in other GNU packages. Here’s what Autoconf/Gnulib INSTALL looks 
like now:

https://git.savannah.gnu.org/cgit/gnulib.git/plain/doc/INSTALL

And in glibc INSTALL, ASCII quotes are a bit confusing in some places, 
e.g., its line:

      example, '--with-pkgversion='FooBar GNU/Linux glibc build 123''.

uses ' for both kinds of quotes, whereas it’s a bit better to use 
English-language single quotation marks ‘like this’ for the outer quotes 
and ASCII apostrophe 'like this' for the inner quotes. True, many people 
won’t notice the difference but it’s quite visible at least to me, with 
the default Emacs fonts on my platform.

How about if we install the attached further patch to glibc?
Siddhesh Poyarekar June 29, 2023, 6:10 p.m. UTC | #9
On 2023-06-29 12:32, Paul Eggert wrote:
> On 2023-06-29 06:48, Siddhesh Poyarekar via Libc-alpha wrote:
>> Alternatively I could just regenerate and push INSTALL with the 
>> updated quotation marks, would you prefer that?
> 
> I’d prefer that, yes. Gnulib switched INSTALL from ASCII to UTF-8 in 
> January, mimicking the planned next Autoconf release, and it’s worked 
> fine in other GNU packages. Here’s what Autoconf/Gnulib INSTALL looks 
> like now:
> 
> https://git.savannah.gnu.org/cgit/gnulib.git/plain/doc/INSTALL
> 
> And in glibc INSTALL, ASCII quotes are a bit confusing in some places, 
> e.g., its line:
> 
>       example, '--with-pkgversion='FooBar GNU/Linux glibc build 123''.
> 
> uses ' for both kinds of quotes, whereas it’s a bit better to use 
> English-language single quotation marks ‘like this’ for the outer quotes 
> and ASCII apostrophe 'like this' for the inner quotes. True, many people 
> won’t notice the difference but it’s quite visible at least to me, with 
> the default Emacs fonts on my platform.
> 
> How about if we install the attached further patch to glibc?

Thanks, totally works for me.  I pushed it for you because I wanted to 
rebase my patches on top of it, which I'm going to send out in a bit.

Sid
diff mbox series

Patch

diff --git a/INSTALL b/INSTALL
index 6d51475536..f921f82b4c 100644
--- a/INSTALL
+++ b/INSTALL
@@ -469,8 +469,8 @@  build the GNU C Library:
 
    * GNU 'make' 4.0 or newer
 
-     As of release time, GNU 'make' 4.4 is the newest verified to work to
-     build the GNU C Library.
+     As of release time, GNU 'make' 4.4 is the newest verified to work
+     to build the GNU C Library.
 
    * GCC 6.2 or newer
 
diff --git a/Makefile b/Makefile
index f324df7a1f..f26050204a 100644
--- a/Makefile
+++ b/Makefile
@@ -734,7 +734,7 @@  endif
 INSTALL: manual/install-plain.texi manual/macros.texi \
 	 $(common-objpfx)manual/pkgvers.texi manual/install.texi
 	makeinfo --no-validate --plaintext --no-number-sections \
-		 -I$(common-objpfx)manual $< -o $@-tmp
+		 --disable-encoding -I$(common-objpfx)manual $< -o $@-tmp
 	$(AWK) 'NF == 0 { ++n; next } \
 		NF != 0 { while (n-- > 0) print ""; n = 0; print }' \
 	  < $@-tmp > $@-tmp2