* [PATCH] Extend --with-zstd documentation
@ 2022-05-11 15:10 Bruno Haible
2022-05-12 7:00 ` Richard Biener
0 siblings, 1 reply; 4+ messages in thread
From: Bruno Haible @ 2022-05-11 15:10 UTC (permalink / raw)
To: gcc-patches; +Cc: marxin
The patch that was so far added for documenting --with-zstd is pretty
minimal:
- it refers to undocumented options --with-zstd-include and
--with-zstd-lib;
- it suggests that --with-zstd can be used without an argument;
- it does not clarify how this option applies to cross-compilation.
How about adding the same details as for the --with-isl,
--with-isl-include, --with-isl-lib options, mutatis mutandis? This patch
does that.
PR other/105527
gcc/ChangeLog:
* doc/install.texi (Configuration): Add more details about --with-zstd.
Document --with-zstd-include and --with-zstd-lib
---
diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index 042241e9fad..ed0d1d882c3 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -2360,10 +2360,20 @@ default is derived from glibc's behavior. When glibc clamps float_t to double,
GCC follows and enables the option. For other cross compiles, the default is
disabled.
-@item --with-zstd
-Specify prefix directory for installed zstd library.
-Equivalent to @option{--with-zstd-include=PATH/include} plus
-@option{--with-zstd-lib=PATH/lib}.
+@item --with-zstd=@var{pathname}
+@itemx --with-zstd-include=@var{pathname}
+@itemx --with-zstd-lib=@var{pathname}
+If you do not have the @code{zstd} library installed in a standard
+location and you want to build GCC, you can explicitly specify the
+directory where it is installed (@samp{--with-zstd=@/@var{zstdinstalldir}}).
+The @option{--with-zstd=@/@var{zstdinstalldir}} option is shorthand for
+@option{--with-zstd-lib=@/@var{zstdinstalldir}/lib} and
+@option{--with-zstd-include=@/@var{zstdinstalldir}/include}. If this
+shorthand assumption is not correct, you can use the explicit
+include and lib options directly.
+
+These flags are applicable to the host platform only. When building
+a cross compiler, they will not be used to configure target libraries.
@end table
@subheading Cross-Compiler-Specific Options
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] Extend --with-zstd documentation
2022-05-11 15:10 [PATCH] Extend --with-zstd documentation Bruno Haible
@ 2022-05-12 7:00 ` Richard Biener
2022-05-16 9:27 ` Martin Liška
0 siblings, 1 reply; 4+ messages in thread
From: Richard Biener @ 2022-05-12 7:00 UTC (permalink / raw)
To: Bruno Haible; +Cc: GCC Patches, marxin
On Wed, May 11, 2022 at 5:10 PM Bruno Haible <bruno@clisp.org> wrote:
>
> The patch that was so far added for documenting --with-zstd is pretty
> minimal:
> - it refers to undocumented options --with-zstd-include and
> --with-zstd-lib;
> - it suggests that --with-zstd can be used without an argument;
> - it does not clarify how this option applies to cross-compilation.
>
> How about adding the same details as for the --with-isl,
> --with-isl-include, --with-isl-lib options, mutatis mutandis? This patch
> does that.
Sounds good!
OK.
Thanks,
Richard.
> PR other/105527
>
> gcc/ChangeLog:
>
> * doc/install.texi (Configuration): Add more details about --with-zstd.
> Document --with-zstd-include and --with-zstd-lib
> ---
> diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
> index 042241e9fad..ed0d1d882c3 100644
> --- a/gcc/doc/install.texi
> +++ b/gcc/doc/install.texi
> @@ -2360,10 +2360,20 @@ default is derived from glibc's behavior. When glibc clamps float_t to double,
> GCC follows and enables the option. For other cross compiles, the default is
> disabled.
>
> -@item --with-zstd
> -Specify prefix directory for installed zstd library.
> -Equivalent to @option{--with-zstd-include=PATH/include} plus
> -@option{--with-zstd-lib=PATH/lib}.
> +@item --with-zstd=@var{pathname}
> +@itemx --with-zstd-include=@var{pathname}
> +@itemx --with-zstd-lib=@var{pathname}
> +If you do not have the @code{zstd} library installed in a standard
> +location and you want to build GCC, you can explicitly specify the
> +directory where it is installed (@samp{--with-zstd=@/@var{zstdinstalldir}}).
> +The @option{--with-zstd=@/@var{zstdinstalldir}} option is shorthand for
> +@option{--with-zstd-lib=@/@var{zstdinstalldir}/lib} and
> +@option{--with-zstd-include=@/@var{zstdinstalldir}/include}. If this
> +shorthand assumption is not correct, you can use the explicit
> +include and lib options directly.
> +
> +These flags are applicable to the host platform only. When building
> +a cross compiler, they will not be used to configure target libraries.
> @end table
>
> @subheading Cross-Compiler-Specific Options
>
>
>
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] Extend --with-zstd documentation
2022-05-12 7:00 ` Richard Biener
@ 2022-05-16 9:27 ` Martin Liška
2022-05-24 11:24 ` Martin Liška
0 siblings, 1 reply; 4+ messages in thread
From: Martin Liška @ 2022-05-16 9:27 UTC (permalink / raw)
To: Richard Biener, Bruno Haible; +Cc: marxin, GCC Patches
On 5/12/22 09:00, Richard Biener via Gcc-patches wrote:
> On Wed, May 11, 2022 at 5:10 PM Bruno Haible <bruno@clisp.org> wrote:
>>
>> The patch that was so far added for documenting --with-zstd is pretty
>> minimal:
>> - it refers to undocumented options --with-zstd-include and
>> --with-zstd-lib;
>> - it suggests that --with-zstd can be used without an argument;
>> - it does not clarify how this option applies to cross-compilation.
>>
>> How about adding the same details as for the --with-isl,
>> --with-isl-include, --with-isl-lib options, mutatis mutandis? This patch
>> does that.
>
> Sounds good!
>
> OK.
Bruno, are you planning committing the change? Or should I do it on your
behalf?
Cheers,
Martin
>
> Thanks,
> Richard.
>
>> PR other/105527
>>
>> gcc/ChangeLog:
>>
>> * doc/install.texi (Configuration): Add more details about --with-zstd.
>> Document --with-zstd-include and --with-zstd-lib
>> ---
>> diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
>> index 042241e9fad..ed0d1d882c3 100644
>> --- a/gcc/doc/install.texi
>> +++ b/gcc/doc/install.texi
>> @@ -2360,10 +2360,20 @@ default is derived from glibc's behavior. When glibc clamps float_t to double,
>> GCC follows and enables the option. For other cross compiles, the default is
>> disabled.
>>
>> -@item --with-zstd
>> -Specify prefix directory for installed zstd library.
>> -Equivalent to @option{--with-zstd-include=PATH/include} plus
>> -@option{--with-zstd-lib=PATH/lib}.
>> +@item --with-zstd=@var{pathname}
>> +@itemx --with-zstd-include=@var{pathname}
>> +@itemx --with-zstd-lib=@var{pathname}
>> +If you do not have the @code{zstd} library installed in a standard
>> +location and you want to build GCC, you can explicitly specify the
>> +directory where it is installed (@samp{--with-zstd=@/@var{zstdinstalldir}}).
>> +The @option{--with-zstd=@/@var{zstdinstalldir}} option is shorthand for
>> +@option{--with-zstd-lib=@/@var{zstdinstalldir}/lib} and
>> +@option{--with-zstd-include=@/@var{zstdinstalldir}/include}. If this
>> +shorthand assumption is not correct, you can use the explicit
>> +include and lib options directly.
>> +
>> +These flags are applicable to the host platform only. When building
>> +a cross compiler, they will not be used to configure target libraries.
>> @end table
>>
>> @subheading Cross-Compiler-Specific Options
>>
>>
>>
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] Extend --with-zstd documentation
2022-05-16 9:27 ` Martin Liška
@ 2022-05-24 11:24 ` Martin Liška
0 siblings, 0 replies; 4+ messages in thread
From: Martin Liška @ 2022-05-24 11:24 UTC (permalink / raw)
To: Richard Biener, Bruno Haible; +Cc: marxin, GCC Patches
On 5/16/22 11:27, Martin Liška wrote:
> On 5/12/22 09:00, Richard Biener via Gcc-patches wrote:
>> On Wed, May 11, 2022 at 5:10 PM Bruno Haible <bruno@clisp.org> wrote:
>>>
>>> The patch that was so far added for documenting --with-zstd is pretty
>>> minimal:
>>> - it refers to undocumented options --with-zstd-include and
>>> --with-zstd-lib;
>>> - it suggests that --with-zstd can be used without an argument;
>>> - it does not clarify how this option applies to cross-compilation.
>>>
>>> How about adding the same details as for the --with-isl,
>>> --with-isl-include, --with-isl-lib options, mutatis mutandis? This patch
>>> does that.
>>
>> Sounds good!
>>
>> OK.
>
> Bruno, are you planning committing the change? Or should I do it on your
> behalf?
Pushed as 3677eb80b683cead7db972bc206fd2e75d997bd2 with the corresponding
Signed-off-by signature.
Martin
>
> Cheers,
> Martin
>
>>
>> Thanks,
>> Richard.
>>
>>> PR other/105527
>>>
>>> gcc/ChangeLog:
>>>
>>> * doc/install.texi (Configuration): Add more details about --with-zstd.
>>> Document --with-zstd-include and --with-zstd-lib
>>> ---
>>> diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
>>> index 042241e9fad..ed0d1d882c3 100644
>>> --- a/gcc/doc/install.texi
>>> +++ b/gcc/doc/install.texi
>>> @@ -2360,10 +2360,20 @@ default is derived from glibc's behavior. When glibc clamps float_t to double,
>>> GCC follows and enables the option. For other cross compiles, the default is
>>> disabled.
>>>
>>> -@item --with-zstd
>>> -Specify prefix directory for installed zstd library.
>>> -Equivalent to @option{--with-zstd-include=PATH/include} plus
>>> -@option{--with-zstd-lib=PATH/lib}.
>>> +@item --with-zstd=@var{pathname}
>>> +@itemx --with-zstd-include=@var{pathname}
>>> +@itemx --with-zstd-lib=@var{pathname}
>>> +If you do not have the @code{zstd} library installed in a standard
>>> +location and you want to build GCC, you can explicitly specify the
>>> +directory where it is installed (@samp{--with-zstd=@/@var{zstdinstalldir}}).
>>> +The @option{--with-zstd=@/@var{zstdinstalldir}} option is shorthand for
>>> +@option{--with-zstd-lib=@/@var{zstdinstalldir}/lib} and
>>> +@option{--with-zstd-include=@/@var{zstdinstalldir}/include}. If this
>>> +shorthand assumption is not correct, you can use the explicit
>>> +include and lib options directly.
>>> +
>>> +These flags are applicable to the host platform only. When building
>>> +a cross compiler, they will not be used to configure target libraries.
>>> @end table
>>>
>>> @subheading Cross-Compiler-Specific Options
>>>
>>>
>>>
>
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-05-24 11:24 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-05-11 15:10 [PATCH] Extend --with-zstd documentation Bruno Haible
2022-05-12 7:00 ` Richard Biener
2022-05-16 9:27 ` Martin Liška
2022-05-24 11:24 ` Martin Liška
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).