gcc.texi: problem generating documentation

gcc.texi: problem generating documentation

[christophe.jarry]

Hello,

I am contributing to the gNewSense project and I am currently looking  
for a way to create GCC documentation in info format for metad version  
of gNewSense.

I found GCC documentation source at  
http://gcc.gnu.org/onlinedocs/docs-sources.tar.gz, then extracted it  
under /tmp.

But I have a problem when I want to makeinfo 'gcc.texi' file:

   user@machine /tmp/gcc/gcc/doc
   $ makeinfo gcc.texi
   gcc.texi:25: @include 'gcc-common.texi': No such file or directory
   [...]

'gcc-common.texi' is in fact in the ./include  
(/tmp/gcc/gcc/doc/include in this case) directory, while gcc.texi  
calls it with a '@include gcc-common.texi'.

I browsed gcc and gcc-help mailing-lists archives but didn't find a  
way to figure this out. A web search with 'gcc-common.texi' and  
'makeinfo' keywords wasn't more successful.

Is that a bug?

Other files call 'gcc-common.texi':

   cpp.texi
   cppinternals.texi
   gccint.texi
   install.texi
   sourcebuild.texi

Thanks in advance for your help,

Christophe

----------------------------------------------------------------
This message was sent using IMP, the Internet Messaging Program.

Re: gcc.texi: problem generating documentation

[Ian Lance Taylor]

christophe.jarry@ouvaton.org writes:

> I am contributing to the gNewSense project and I am currently looking
> for a way to create GCC documentation in info format for metad version
> of gNewSense.
>
> I found GCC documentation source at
> http://gcc.gnu.org/onlinedocs/docs-sources.tar.gz, then extracted it
> under /tmp.
>
> But I have a problem when I want to makeinfo 'gcc.texi' file:
>
>   user@machine /tmp/gcc/gcc/doc
>   $ makeinfo gcc.texi
>   gcc.texi:25: @include 'gcc-common.texi': No such file or directory
>   [...]

To make the gcc info files, download the gcc sources and run "make
info".  Or if docs-sources.tar.gz contains a Makefile--I haven't
looked and I don't know what creates that tar file--try running "make
info" with the sources you have.

Ian

Re: gcc.texi: problem generating documentation

[Christophe Jarry]

Le Wed, 03 Mar 2010 07:43:45 -0800,
Ian Lance Taylor <iant@google.com> a écrit :

> christophe.jarry@ouvaton.org writes:
> 
> > I am contributing to the gNewSense project and I am currently
> > looking for a way to create GCC documentation in info format for
> > metad version of gNewSense.
> >
> > I found GCC documentation source at
> > http://gcc.gnu.org/onlinedocs/docs-sources.tar.gz, then extracted it
> > under /tmp.
> >
> > But I have a problem when I want to makeinfo 'gcc.texi' file:
> >
> >   user@machine /tmp/gcc/gcc/doc
> >   $ makeinfo gcc.texi
> >   gcc.texi:25: @include 'gcc-common.texi': No such file or directory
> >   [...]
> 
> To make the gcc info files, download the gcc sources and run "make
> info".

I did this in 'gcc-4.4.3/gcc/doc' folder extracted from gcc source, as
well as in 'gcc/gcc/doc' folder extracted from gcc _doc_ source:

  make info

And I have the following error message in both situations:

  make: *** No rule to make target 'info'. Stop.


Note: gcc-4.4.3/gcc/doc as well as gcc/gcc/doc contain only one makefile
namely 'makefile.texi'.

> Or if docs-sources.tar.gz contains a Makefile--I haven't
> looked and I don't know what creates that tar file--try running "make
> info" with the sources you have.
> 
> Ian

Re: gcc.texi: problem generating documentation

[Ian Lance Taylor]

Christophe Jarry <christophe.jarry@ouvaton.org> writes:

> I did this in 'gcc-4.4.3/gcc/doc' folder extracted from gcc source, as
> well as in 'gcc/gcc/doc' folder extracted from gcc _doc_ source:

You need to first run configure in a new empty directory as described
in the gcc installation instructions.  Then you can run "make info" in
the gcc subdirectory.

Ian

Re: gcc.texi: problem generating documentation

[christophe.jarry]

Quoting Ian Lance Taylor <iant@google.com>:

> Christophe Jarry <christophe.jarry@ouvaton.org> writes:
>
>> I did this in 'gcc-4.4.3/gcc/doc' folder extracted from gcc source, as
>> well as in 'gcc/gcc/doc' folder extracted from gcc _doc_ source:
>
> You need to first run configure in a new empty directory as described
> in the gcc installation instructions.  Then you can run "make info" in
> the gcc subdirectory.
>
> Ian
>

Thanks Ian, it seems to work when compiling from source code, in  
gcc-4.4.3/ directory:

   ./configure
   make info

Then, I have a gcc-4.4.3/gcc/doc/gcc.info file about 1.9M in size (ls  
-s -h gcc.info).


Now, is it possible to build GCC documentation directly from  
http://gcc.gnu.org/onlinedocs/docs-sources.tar.gz file, instead of  
having to download GCC whole source code? From extracted  
docs-sources.tar.gz file, I tried this:

   cd gcc/gcc/doc
   makeinfo -I include/ gcc.texi

But then, I have the following error message:

   include//gcc-common.texi:12: @include `gcc-vers.texi': No such file  
or directory.
   gcc.texi:125: warning: undefined flag: version-GCC.
   /cygdrive/d/cj/gnu-linux/gcc/gcc/doc//invoke.texi:1301: warning:  
undefined flag: srcdir.
   /cygdrive/d/cj/gnu-linux/gcc/gcc/doc//invoke.texi:1300: @include  
`{No value for `srcdir'}/../libiberty/at-file.texi': No such file or  
directory.
   /cygdrive/d/cj/gnu-linux/gcc/gcc/doc//bugreport.texi:91: warning:  
undefined flag: BUGURL.
   makeinfo: Removing output file  
`/cygdrive/d/cj/gnu-linux/gcc/gcc/doc/gcc.info' due to errors; use  
--force to preserve.

Notes:
- there is no 'gcc-vers.texi' file in the entire gcc/ directory,
- there is an 'at-file.texi' in gcc/libiberty/, but I don't know how  
to define 'srcdir' flag?

Thanks for your help,

Christophe

----------------------------------------------------------------
This message was sent using IMP, the Internet Messaging Program.

Re: gcc.texi: problem generating documentation

[Ian Lance Taylor]

christophe.jarry@ouvaton.org writes:

> Now, is it possible to build GCC documentation directly from
> http://gcc.gnu.org/onlinedocs/docs-sources.tar.gz file, instead of
> having to download GCC whole source code?

I have no idea.  I don't know what creates that tar file.  If you want
to find out what creates that file and fix it up so that "make info"
works, I'm sure that help somebody in the future.  Note that simply
running "makeinfo" is not likely to be a useful goal; the useful goal
is "make info".

> - there is no 'gcc-vers.texi' file in the entire gcc/ directory,

gcc-vers.texi is created at "make" time.  There is a rule in
gcc/Makefile.

> - there is an 'at-file.texi' in gcc/libiberty/, but I don't know how
> to define 'srcdir' flag?

srcdir is normally set by gcc-vers.texi.

Ian

Re: gcc.texi: problem generating documentation

[Christophe Jarry]

Le Thu, 4 Mar 2010 05:17:39 -0800,
"John (Eljay) Love-Jensen" <eljay@adobe.com> a écrit :

> In the general case, you'll want to do this:
> 
> cd ~/gcc-4.4.3 (or wherever the gcc-4.4.3 source is located)
> mkdir ../gcc-4.4.3-build (peer build directory to gcc-4.4.3 source)
> cd ../gcc-4.4.3-build
> ../gcc-4.4.3/configure
> make info

I tried this, but got an error after invoking _make info_:

/home/christophe/gnewsense/projects/doc-rejected-by-debian/tmp/gcc-4.4.3/libgomp/configure:
line
2194: /home/christophe/gnewsense/projects/doc-rejected-by-debian/tmp/gcc-perso/./gcc/xgcc:
No such file or directory configure: error: in
`/home/christophe/gnewsense/projects/doc-rejected-by-debian/tmp/gcc-perso/mips64el-unknown-linux-gnu/libgomp':
configure: error: C compiler cannot create executables See `config.log'
for more details. make[1]: *** [configure-target-libgomp] Erreur 1
make: *** [do-info] Erreur 2


But, the good news is that invoking:

../gcc-4.4.3/configure
make info

did create _./gcc/gcc-vers.texi_. This allowed me to create 9
gcc.info* files from gcc's docs-sources.tar.gz at
http://gcc.gnu.org/onlinedocs/docs-sources.tar.gz and get rid of the
error I had previously, when building .info documentation from
docs-sources.tar.gz:

include//gcc-common.texi:12: @include `gcc-vers.texi': No such file or
directory. gcc.texi:125: warning: undefined flag: version-GCC.
/cygdrive/d/cj/gnu-linux/gcc/gcc/doc//invoke.texi:1301: warning:
undefined flag:
srcdir. /cygdrive/d/cj/gnu-linux/gcc/gcc/doc//invoke.texi:1300:
@include `{No value for `srcdir'}/../libiberty/at-file.texi': No such
file or
directory. /cygdrive/d/cj/gnu-linux/gcc/gcc/doc//bugreport.texi:91:
warning: undefined flag: BUGURL. makeinfo: Removing output file
`/cygdrive/d/cj/gnu-linux/gcc/gcc/doc/gcc.info' due to errors; use
--force to preserve.

I just made (from inside gcc-perso/ directory):

cp gcc/gcc-vers.texi ../gcc/gcc/
cd ../gcc/gcc/doc
makeinfo -I include -I ../ gcc.texi


I think the file gcc-vers.texi should be included by default in
docs-sources.tar.gz, this would save a lot of time.

For those interested, the content of my gcc-vers.texi is:

@set version-GCC 4.4.3
@clear DEVELOPMENT
@set
srcdir /home/christophe/gnewsense/projects/doc-rejected-by-debian/tmp/gcc-perso/gcc/../../gcc-4.4.3/gcc
@set VERSION_PACKAGE (GCC) @set BUGURL
@uref{http://gcc.gnu.org/bugs.html}

Christophe