Problem generating documentation

Problem generating documentation

[Xan Lopez]

Hi,

Using commit 32b12f40509e4bcb0823e1bb2a57e50af14560b5, I get the
following error when the doc is being generated:

make[3]: Entering directory `/home/xan/git/guile/libguile'
cat alist.doc arbiters.doc array-handle.doc array-map.doc arrays.doc
async.doc backtrace.doc boolean.doc bitvectors.doc bytevectors.doc
chars.doc continuations.doc debug.doc deprecated.doc deprecation.doc
discouraged.doc dynl.doc dynwind.doc eq.doc error.doc eval.doc
evalext.doc extensions.doc feature.doc fluids.doc fports.doc
futures.doc gc-malloc.doc gc.doc gettext.doc generalized-arrays.doc
generalized-vectors.doc goops.doc gsubr.doc guardians.doc hash.doc
hashtab.doc hooks.doc i18n.doc init.doc ioext.doc keywords.doc
lang.doc list.doc load.doc macros.doc mallocs.doc modules.doc
numbers.doc objects.doc objprop.doc options.doc pairs.doc ports.doc
print.doc procprop.doc procs.doc properties.doc r6rs-ports.doc
random.doc rdelim.doc read.doc root.doc rw.doc scmsigs.doc script.doc
simpos.doc smob.doc sort.doc srcprop.doc srfi-13.doc srfi-14.doc
srfi-4.doc stackchk.doc stacks.doc stime.doc strings.doc strorder.doc
strports.doc struct.doc symbols.doc threads.doc throw.doc uniform.doc
values.doc variable.doc vectors.doc version.doc vports.doc weaks.doc
dynl.doc filesys.doc posix.doc net_db.doc socket.doc regex-posix.doc |
GUILE_AUTO_COMPILE=0 ../meta/uninstalled-env guile-tools
snarf-check-and-output-texi          > guile-procedures.texi || { rm
guile-procedures.texi; false; }
ERROR: In procedure skip_block_comment:
ERROR: /home/xan/git/guile/guile-tools:1:3: unterminated `#! ... !#' comment
make[3]: *** [guile-procedures.texi] Error 1
make[3]: Leaving directory `/home/xan/git/guile/libguile'
make[2]: *** [all] Error 2
make[2]: Leaving directory `/home/xan/git/guile/libguile'
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/home/xan/git/guile'
make: *** [all] Error 2
niraikanai:~/git/guile%git log

Apparently someone is interpreting the shebang as a comment, and is
aborting when it sees the comment is not finished. Not sure what tools
of those I have would be relevant here, so I won't start listing
everything under the Sun. Just ask away :)

Cheers, Xan

Re: Problem generating documentation

[Neil Jerram]

Xan Lopez <xan@gnome.org> writes:

> Hi,
>
> Using commit 32b12f40509e4bcb0823e1bb2a57e50af14560b5, I get the
> following error when the doc is being generated:

> ERROR: In procedure skip_block_comment:
> ERROR: /home/xan/git/guile/guile-tools:1:3: unterminated `#! ... !#' comment

If you take a look at /home/xan/git/guile/guile-tools, is the comment
really unterminated (as a Scheme block comment)?  There should be

!#

on its own on line 4, and that terminates the block comment.

> Apparently someone is interpreting the shebang as a comment,

Yes, Guile does that.  See `Block Comments' in the manual.

Regards,
        Neil

Re: Problem generating documentation

[Xan Lopez]

On Sat, Oct 24, 2009 at 10:55 AM, Neil Jerram <neil@ossau.uklinux.net> wrote:
> Xan Lopez <xan@gnome.org> writes:
>
>> Hi,
>>
>> Using commit 32b12f40509e4bcb0823e1bb2a57e50af14560b5, I get the
>> following error when the doc is being generated:
>
>> ERROR: In procedure skip_block_comment:
>> ERROR: /home/xan/git/guile/guile-tools:1:3: unterminated `#! ... !#' comment
>
> If you take a look at /home/xan/git/guile/guile-tools, is the comment
> really unterminated (as a Scheme block comment)?  There should be
>
> !#
>
> on its own on line 4, and that terminates the block comment.

Ok, the problem is that I had a file named "guile-tools" in the
toplevel, which was a shell script and had nothing to do with
meta/guile-tools (no idea how it got there...), which is what I assume
you were talking about. If I do a 'git status' git says it does not
know anything about that, so I moved it out of the way, did a 'git
clean -f', and now things seem to work OK.

So I guess we can close the issue unless someone wants to figure out
how that file managed to be generated.

Re: Problem generating documentation

[Ludovic Courtès]

Hello,

Xan Lopez <xan@gnome.org> writes:

> On Sat, Oct 24, 2009 at 10:55 AM, Neil Jerram <neil@ossau.uklinux.net> wrote:
>> Xan Lopez <xan@gnome.org> writes:
>>
>>> Hi,
>>>
>>> Using commit 32b12f40509e4bcb0823e1bb2a57e50af14560b5, I get the
>>> following error when the doc is being generated:
>>
>>> ERROR: In procedure skip_block_comment:
>>> ERROR: /home/xan/git/guile/guile-tools:1:3: unterminated `#! ... !#' comment
>>
>> If you take a look at /home/xan/git/guile/guile-tools, is the comment
>> really unterminated (as a Scheme block comment)?  There should be
>>
>> !#
>>
>> on its own on line 4, and that terminates the block comment.
>
> Ok, the problem is that I had a file named "guile-tools" in the
> toplevel, which was a shell script and had nothing to do with
> meta/guile-tools (no idea how it got there...), which is what I assume
> you were talking about.

I just hit that too.  The stale $top_builddir/guile-tools typically
comes from ‘branch_release-1-8’ or from a very old build of ‘master’.

Thanks,
Ludo’.

Re: Problem generating documentation

[Neil Jerram]

ludo@gnu.org (Ludovic Courtès) writes:

> Hello,
>
> Xan Lopez <xan@gnome.org> writes:

>> Ok, the problem is that I had a file named "guile-tools" in the
>> toplevel, which was a shell script and had nothing to do with
>> meta/guile-tools (no idea how it got there...), which is what I assume
>> you were talking about.

Cool, thanks for closing the loop on this.

> I just hit that too.  The stale $top_builddir/guile-tools typically
> comes from ‘branch_release-1-8’ or from a very old build of ‘master’.

But is it cleaned by make distclean?  I would guess so, since I
regularly switch between branches, using make distclean, and have never
seen this.

If make distclean does clean it, I don't think we need anything else -
unless someone wants to propose a patch to HACKING to cover this.

   Neil

Re: Problem generating documentation

[Andy Wingo]

Hi,

On Tue 27 Oct 2009 22:20, Neil Jerram <neil@ossau.uklinux.net> writes:

> ludo@gnu.org (Ludovic Courtès) writes:
>
>> Hello,
>>
>> Xan Lopez <xan@gnome.org> writes:
>
>>> Ok, the problem is that I had a file named "guile-tools" in the
>>> toplevel, which was a shell script and had nothing to do with
>>> meta/guile-tools (no idea how it got there...), which is what I assume
>>> you were talking about.
>
> Cool, thanks for closing the loop on this.
>
>> I just hit that too.  The stale $top_builddir/guile-tools typically
>> comes from ‘branch_release-1-8’ or from a very old build of ‘master’.
>
> But is it cleaned by make distclean?  I would guess so, since I
> regularly switch between branches, using make distclean, and have never
> seen this.

I think the deal was that it used to be generated, and in the root. But
I changed it to be not generated, and in the meta/. But this error was
coming from Scheme; perhaps there was a issue with load path issue
whereby guile-tools was loaded from a path and not absolutely?

There might be a deeper bug lurking here. I can't think through it right
now though.

Andy
-- 
http://wingolog.org/

Re: Problem generating documentation

[Ludovic Courtès]

Hi,

Andy Wingo <wingo@pobox.com> writes:

> I think the deal was that it used to be generated, and in the root. But
> I changed it to be not generated, and in the meta/. But this error was
> coming from Scheme; perhaps there was a issue with load path issue
> whereby guile-tools was loaded from a path and not absolutely?

Yes, I think so.  It’s run as “./meta/uninstalled-env guile-tools” and
somehow it seems that $top_builddir ended up before $top_builddir/meta
in $PATH (don’t ask me why :-)).

Thanks,
Ludo’.

Re: Problem generating documentation

[Neil Jerram]

ludo@gnu.org (Ludovic Courtès) writes:

> Hi,
>
> Andy Wingo <wingo@pobox.com> writes:
>
>> I think the deal was that it used to be generated, and in the root. But
>> I changed it to be not generated, and in the meta/. But this error was
>> coming from Scheme; perhaps there was a issue with load path issue
>> whereby guile-tools was loaded from a path and not absolutely?
>
> Yes, I think so.  It’s run as “./meta/uninstalled-env guile-tools” and
> somehow it seems that $top_builddir ended up before $top_builddir/meta
> in $PATH (don’t ask me why :-)).

Hmm, it still seems to me that the old generated one should have been
deleted by `make distclean', and hence with an invocation of `make
distclean' (before `git pull' or `git checkout some-other-branch') this
wouldn't have happened.

       Neil

Re: Problem generating documentation

[Andy Wingo]

On Wed 28 Oct 2009 22:03, Neil Jerram <neil@ossau.uklinux.net> writes:

> ludo@gnu.org (Ludovic Courtès) writes:
>
>> Andy Wingo <wingo@pobox.com> writes:
>>
>>> I think the deal was that it used to be generated, and in the root. But
>>> I changed it to be not generated, and in the meta/. But this error was
>>> coming from Scheme; perhaps there was a issue with load path issue
>>> whereby guile-tools was loaded from a path and not absolutely?
>>
>> Yes, I think so.  It’s run as “./meta/uninstalled-env guile-tools” and
>> somehow it seems that $top_builddir ended up before $top_builddir/meta
>> in $PATH (don’t ask me why :-)).
>
> Hmm, it still seems to me that the old generated one should have been
> deleted by `make distclean', and hence with an invocation of `make
> distclean' (before `git pull' or `git checkout some-other-branch') this
> wouldn't have happened.

Well the one in the $top_builddir wouldn't have been deleted, as it was
moved to $top_builddir/meta.

A
-- 
http://wingolog.org/

Re: Problem generating documentation

[Ludovic Courtès]

Hi,

Neil Jerram <neil@ossau.uklinux.net> writes:

> ludo@gnu.org (Ludovic Courtès) writes:

[...]

>> Yes, I think so.  It’s run as “./meta/uninstalled-env guile-tools” and
>> somehow it seems that $top_builddir ended up before $top_builddir/meta
>> in $PATH (don’t ask me why :-)).
>
> Hmm, it still seems to me that the old generated one should have been
> deleted by `make distclean', and hence with an invocation of `make
> distclean' (before `git pull' or `git checkout some-other-branch') this
> wouldn't have happened.

You're probably right, but I had skipped that step.

Ludo’.