[Bug other/105527] New: configure option --with-zstd is not documented

[Bug other/105527] New: configure option --with-zstd is not documented

[bruno at clisp dot org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

            Bug ID: 105527
           Summary: configure option --with-zstd is not documented
           Product: gcc
           Version: 12.1.0
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: other
          Assignee: unassigned at gcc dot gnu.org
          Reporter: bruno at clisp dot org
  Target Milestone: ---

A GCC 12.1.0 build of mine is failing with the error messages

/usr/lib/gcc-cross/i686-linux-gnu/10/../../../../i686-linux-gnu/bin/ld:
/build-loongarch64-linux/gcc-12.1.0/gcc/../../../../sources/gcc-12.1.0/gcc/lto-compress.cc:170:
undefined reference to `ZSTD_isError'
/usr/lib/gcc-cross/i686-linux-gnu/10/../../../../i686-linux-gnu/bin/ld:
/build-loongarch64-linux/gcc-12.1.0/gcc/../../../../sources/gcc-12.1.0/gcc/lto-compress.cc:171:
undefined reference to `ZSTD_getErrorName'
collect2: error: ld returned 1 exit status
make: *** [/sources/gcc-12.1.0/gcc/c/Make-lang.in:87: cc1] error 1

Obviously, the ZStd prerequisite is missing. The documentation (in
gcc-12.1.0/gcc/doc/gccinstall.info and in
https://gcc.gnu.org/install/prerequisites.html) merely says "Alternatively, the
--with-zstd configure option should be used." But what is its argument?

I would expect to see this documented
1. in gcc-12.1.0/gcc/doc/gccinstall.info node "Configuration",
2. also in https://gcc.gnu.org/install/configure.html.

The only hint I can get is by running "gcc-12.1.0/gcc/configure --help", which
prints

  --with-zstd=PATH        specify prefix directory for installed zstd library.
                          Equivalent to --with-zstd-include=PATH/include plus
                          --with-zstd-lib=PATH/lib
  --with-zstd-include=PATH
                          specify directory for installed zstd include files
  --with-zstd-lib=PATH    specify directory for the installed zstd library

This text gives the answer. It should be added to the .texi documentation.

[Bug other/105527] configure option --with-zstd is not documented

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
   Last reconfirmed|                            |2022-05-09
           Assignee|unassigned at gcc dot gnu.org      |marxin at gcc dot gnu.org
             Status|UNCONFIRMED                 |ASSIGNED
                 CC|                            |marxin at gcc dot gnu.org
     Ever confirmed|0                           |1

[Bug other/105527] configure option --with-zstd is not documented

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

--- Comment #1 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Martin Liska <marxin@gcc.gnu.org>:

https://gcc.gnu.org/g:8fa689767a8a55c889683d178ae3a003ec689927

commit r13-317-g8fa689767a8a55c889683d178ae3a003ec689927
Author: Martin Liska <mliska@suse.cz>
Date:   Wed May 11 13:21:26 2022 +0200

    docs: document --with-zstd

            PR other/105527

    gcc/ChangeLog:

            * doc/install.texi: Document the configure option --with-zstd.

[Bug other/105527] configure option --with-zstd is not documented

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
      Known to work|                            |13.0

--- Comment #2 from Martin Liška <marxin at gcc dot gnu.org> ---
Fixed on master so far.

[Bug other/105527] configure option --with-zstd is not documented

[bruno at clisp dot org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

--- Comment #3 from Bruno Haible <bruno at clisp dot org> ---
Created attachment 52955
  --> https://gcc.gnu.org/bugzilla/attachment.cgi?id=52955&action=edit
Patch to document also --with-zstd-include and --with-zstd-lib

Hi Martin,

The patch you added 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; and 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? Find attached a patch that does that.

[Bug other/105527] configure option --with-zstd is not documented

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

--- Comment #4 from Martin Liška <marxin at gcc dot gnu.org> ---
I welcome that, please send it to gcc-patches mailing list.

[Bug other/105527] configure option --with-zstd is not documented

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Assignee|marxin at gcc dot gnu.org          |unassigned at gcc dot gnu.org
             Status|ASSIGNED                    |NEW

[Bug other/105527] configure option --with-zstd is not documented

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

--- Comment #5 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Martin Liska <marxin@gcc.gnu.org>:

https://gcc.gnu.org/g:3677eb80b683cead7db972bc206fd2e75d997bd2

commit r13-728-g3677eb80b683cead7db972bc206fd2e75d997bd2
Author: Bruno Haible <bruno@clisp.org>
Date:   Wed May 11 17:10:07 2022 +0200

    Extend --with-zstd documentation

    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

    Signed-off-by: Bruno Haible <bruno@clisp.org>

[Bug other/105527] configure option --with-zstd is not documented

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

--- Comment #6 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The releases/gcc-12 branch has been updated by Martin Liska
<marxin@gcc.gnu.org>:

https://gcc.gnu.org/g:f4c0f9257ef2615add8ecb30e7a568755b692473

commit r12-8411-gf4c0f9257ef2615add8ecb30e7a568755b692473
Author: Martin Liska <mliska@suse.cz>
Date:   Wed May 11 13:21:26 2022 +0200

    docs: document --with-zstd

            PR other/105527

    gcc/ChangeLog:

            * doc/install.texi: Document the configure option --with-zstd.

    (cherry picked from commit 8fa689767a8a55c889683d178ae3a003ec689927)

[Bug other/105527] configure option --with-zstd is not documented

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

--- Comment #7 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The releases/gcc-12 branch has been updated by Martin Liska
<marxin@gcc.gnu.org>:

https://gcc.gnu.org/g:394ff2fbfc84eb6d6cfc56b04e28ee9b42a5ab57

commit r12-8412-g394ff2fbfc84eb6d6cfc56b04e28ee9b42a5ab57
Author: Bruno Haible <bruno@clisp.org>
Date:   Wed May 11 17:10:07 2022 +0200

    Extend --with-zstd documentation

    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

    Signed-off-by: Bruno Haible <bruno@clisp.org>
    (cherry picked from commit 3677eb80b683cead7db972bc206fd2e75d997bd2)

[Bug other/105527] configure option --with-zstd is not documented

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105527

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |FIXED
             Status|NEW                         |RESOLVED

--- Comment #8 from Martin Liška <marxin at gcc dot gnu.org> ---
Fixed on gcc-12 branch, closing.