unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: ludo@gnu.org (Ludovic Courtès)
To: bug-texinfo@gnu.org
Cc: guile-devel@gnu.org
Subject: makeinfo swallows page breaks
Date: Thu, 21 Mar 2013 00:14:39 +0100	[thread overview]
Message-ID: <8738vpirz4.fsf@gnu.org> (raw)

Hello,

Guile (ab)uses ‘makeinfo’ to generate a file, guile-procedures.txt, from
Texinfo.  That file is then read at run-time to get docstrings for
Guile’s primitives.

The input looks like this (note the page breaks, aka. ^L):

--8<---------------cut here---------------start------------->8---

\facons
@c snarfed from alist.c:40
@deffn {Scheme Procedure} acons key value alist
Add a new key-value pair to @var{alist}.  A new pair is
created whose car is @var{key} and whose cdr is @var{value}, and the
pair is consed onto @var{alist}, and the new list is returned.  This
function is @emph{not} destructive; @var{alist} is not modified.
@end deffn

\fsloppy-assq
@c snarfed from alist.c:54
@deffn {Scheme Procedure} sloppy-assq key alist
Behaves like @code{assq} but does not do any error checking.
Recommended only for use in Guile internals.
@end deffn

--8<---------------cut here---------------end--------------->8---

With Texinfo 4.3, page breaks are preserved:

--8<---------------cut here---------------start------------->8---
This is guile-procedures.txt, produced by makeinfo version 4.13 from
guile-procedures.texi.

\facons

 -- Scheme Procedure: acons key value alist
     Add a new key-value pair to ALIST.  A new pair is created whose
     car is KEY and whose cdr is VALUE, and the pair is consed onto
     ALIST, and the new list is returned.  This function is _not_
     destructive; ALIST is not modified.

   \fsloppy-assq

 -- Scheme Procedure: sloppy-assq key alist
     Behaves like `assq' but does not do any error checking.
     Recommended only for use in Guile internals.

--8<---------------cut here---------------end--------------->8---

With Texinfo 5.[01], page breaks vanish:

--8<---------------cut here---------------start------------->8---
This is guile-procedures.txt, produced by makeinfo version 5.1 from
guile-procedures.texi.

acons
 -- Scheme Procedure: acons key value alist
     Add a new key-value pair to ALIST.  A new pair is created whose car
     is KEY and whose cdr is VALUE, and the pair is consed onto ALIST,
     and the new list is returned.  This function is _not_ destructive;
     ALIST is not modified.

   sloppy-assq
 -- Scheme Procedure: sloppy-assq key alist
     Behaves like 'assq' but does not do any error checking.
     Recommended only for use in Guile internals.
--8<---------------cut here---------------end--------------->8---

Unfortunately, those page breaks are used by Guile’s docstring parser to
determine procedure boundaries.

Would it be possible to reinstate previous behavior–i.e., to preserve
page breaks?

Alternately, would you suggest using a different approach?

Thanks,
Ludo’.



             reply	other threads:[~2013-03-20 23:14 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-20 23:14 Ludovic Courtès [this message]
2013-03-21 18:25 ` makeinfo swallows page breaks Ludovic Courtès
2013-03-21 18:58   ` Mike Gran
2013-03-21 20:31     ` Ludovic Courtès
2013-03-21 21:56   ` Karl Berry
2013-03-22 10:14     ` Andy Wingo
2013-03-22 10:33   ` Ludovic Courtès
2013-03-22 10:56     ` Ludovic Courtès
2013-03-22 21:42     ` Ludovic Courtès

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/guile/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8738vpirz4.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=bug-texinfo@gnu.org \
    --cc=guile-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).