[BUG] README: Reference to non-existent path?

[BUG] README: Reference to non-existent path?

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 2619 bytes --]

Hi,

I'm trying to understand a few implementation details of gcc for implementing a 
new warning.  For that, I first read the GCC manual [1].

[1]: <https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc.pdf>

However, that manual has nothing about internals, such as 'LangEnabledBy()'.
Then I checked what's in the root of the repo to see what I can read:

     $ ls
     ABOUT-NLS           config-ml.in  libcody          libvtv
     COPYING             config.guess  libcpp           ltgcc.m4
     COPYING.LIB         config.rpath  libdecnumber     ltmain.sh
     COPYING.RUNTIME     config.sub    libffi           lto-plugin
     COPYING3            configure     libgcc           ltoptions.m4
     COPYING3.LIB        configure.ac  libgfortran      ltsugar.m4
     ChangeLog           contrib       libgo            ltversion.m4
     ChangeLog.jit       depcomp       libgomp          lt~obsolete.m4
     ChangeLog.tree-ssa  fixincludes   libiberty        maintainer-scripts
     INSTALL             gcc           libitm           missing
     MAINTAINERS         gnattools     libobjc          mkdep
     Makefile.def        gotools       liboffloadmic    mkinstalldirs
     Makefile.in         include       libphobos        move-if-change
     Makefile.tpl        install-sh    libquadmath      multilib.am
     README              intl          libsanitizer     symlink-tree
     ar-lib              libada        libssp           test-driver
     c++tools            libatomic     libstdc++-v3     ylwrap
     compile             libbacktrace  libtool-ldflags  zlib
     config              libcc1        libtool.m4

The only interesting file seems to be the README.  Let's see what it says:

> The directory INSTALL contains copies of the installation information
> as HTML and plain text.  The source of this information is
> gcc/doc/install.texi.  The installation information includes details
> of what is included in the GCC sources and what files GCC installs.
> 
> See the file gcc/doc/gcc.texi (together with other files that it
> includes) for usage and porting information.  An online readable
> version of the manual is in the files gcc/doc/gcc.info*.

Okay, let's see the online readable version of the manual:

     $ ls gcc/doc/gcc.info*
     ls: cannot access 'gcc/doc/gcc.info*': No such file or directory

No files with that glob(7).  BTW, it might be interesting to provide that manual 
in a package, so that I could install it as something like:

     apt-get install gcc-doc-internal

Cheers,

Alex

-- 
<http://www.alejandro-colomar.es/>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [BUG] README: Reference to non-existent path?

[Jonathan Wakely]

On Mon, 14 Nov 2022 at 15:03, Alejandro Colomar via Gcc <gcc@gcc.gnu.org> wrote:
>
> Hi,
>
> I'm trying to understand a few implementation details of gcc for implementing a
> new warning.  For that, I first read the GCC manual [1].
>
> [1]: <https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc.pdf>

That's the user manual, for GCC internals see the gccint docs:
https://gcc.gnu.org/onlinedocs/gccint/Options.html#Options

Re: [BUG] README: Reference to non-existent path?

[Jonathan Wakely]

On Mon, 14 Nov 2022 at 15:03, Alejandro Colomar wrote:
> BTW, it might be interesting to provide that manual
> in a package, so that I could install it as something like:
>
>      apt-get install gcc-doc-internal

"info gccint" already works fine on my distro. If it's not packaged
for yours, that's a distro issue.

Re: [BUG] README: Reference to non-existent path?

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 546 bytes --]

Hi Jonathan,

On 11/14/22 16:36, Jonathan Wakely wrote:
> On Mon, 14 Nov 2022 at 15:03, Alejandro Colomar wrote:
>> BTW, it might be interesting to provide that manual
>> in a package, so that I could install it as something like:
>>
>>       apt-get install gcc-doc-internal
> 
> "info gccint" already works fine on my distro. If it's not packaged
> for yours, that's a distro issue.

It works.  I didn't know it existed :)

Maybe add a reference to it in the README?

Thanks!

Alex

-- 
<http://www.alejandro-colomar.es/>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [BUG] README: Reference to non-existent path?

[Joseph Myers]

On Mon, 14 Nov 2022, Alejandro Colomar via Gcc wrote:

> Okay, let's see the online readable version of the manual:
> 
>     $ ls gcc/doc/gcc.info*
>     ls: cannot access 'gcc/doc/gcc.info*': No such file or directory

That reference is for releases - those files are in release tarballs, but 
not in git or snapshots.

-- 
Joseph S. Myers
joseph@codesourcery.com