public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH v3 1/2] guile: Add support for Guile 2.2.
Date: Fri, 26 Jun 2020 13:23:26 +0300	[thread overview]
Message-ID: <83a70qruqp.fsf@gnu.org> (raw)
In-Reply-To: <20200626081333.23412-2-ludo@gnu.org> (message from Ludovic =?utf-8?Q?Court=C3=A8s?= on Fri, 26 Jun 2020 10:13:32 +0200)

> From: Ludovic Courtès <ludo@gnu.org>
> Date: Fri, 26 Jun 2020 10:13:32 +0200
> Cc: Ludovic Courtès <ludo@gnu.org>
> 
> diff --git a/gdb/NEWS b/gdb/NEWS
> index a116d62bca..37ab83618e 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -117,6 +117,16 @@ GNU/Linux/RISC-V (gdbserver)	riscv*-*-linux*
>    ** Commands written in Python can be in the "TUI" help class by
>       registering with the new constant gdb.COMMAND_TUI.
>  
> +* Guile API
> +
> +  ** GDB can now be built with GNU Guile 2.2 in addition to 2.0.
> +
> +  ** Procedures 'memory-port-read-buffer-size',
> +     'set-memory-port-read-buffer-size!', 'memory-port-write-buffer-size',
> +     and 'set-memory-port-write-buffer-size!' are deprecated.  When
> +     using Guile 2.2 and later, users who need to control the size of
> +     a memory port's internal buffer can use the 'setvbuf' procedure.
> +

This part is OK.

>  @deffn {Scheme Procedure} set-memory-port-read-buffer-size! memory-port size
>  Set the size of the read buffer of @code{<gdb:memory-port>}
>  @var{memory-port} to @var{size}.  The result is unspecified.
> +
> +This procedure is deprecated and will be removed in @value{GDBN} 11.
> +When using Guile 2.2 or later, you can call @code{setvbuf} instead
> +(@pxref{Buffering, @code{setvbuf},, guile, GNU Guile Reference Manual}).

First, instead of "When using" I'd suggest to say "When @value{GDBN}
was built with".  And second, there's a certain conundrum here: the
node "Buffering" doesn't exist in the Guile v2.0.x manual, so I wonder
whether we should say something here about that to prevent user
surprise when the hyperlink causes an error.

>  @deffn {Scheme Procedure} set-memory-port-write-buffer-size! memory-port size
>  Set the size of the write buffer of @code{<gdb:memory-port>}
>  @var{memory-port} to @var{size}.  The result is unspecified.
> +
> +This procedure is deprecated and will be removed in @value{GDBN} 11.
> +When using Guile 2.2 or later, you can call @code{setvbuf} instead
> +(@pxref{Buffering, @code{setvbuf},, guile, GNU Guile Reference Manual}).
>  @end deffn

Here, I'd remove the @pxref: we already have the same hyperlink a
short ways above, so repetition is not necessary.

The documentation parts are okay with those nits fixed.

> +/* Whether we're using Guile < 2.2 and its clumsy port API.  */
> +
> +#define USING_GUILE_BEFORE_2_2					\
> +  (SCM_MAJOR_VERSION < 2					\
> +   || (SCM_MAJOR_VERSION == 2 && SCM_MINOR_VERSION == 0))

Since Guile < 2.0 is not supported, do we need the first part of the
macro?

Thanks.

  reply	other threads:[~2020-06-26 10:23 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-12 13:27 [PATCH 0/2] Add support for Guile 3.0 and 2.2 Ludovic Courtès
2020-06-12 13:27 ` [PATCH 1/2] guile: Add support for Guile 2.2 Ludovic Courtès
2020-06-12 13:50   ` Eli Zaretskii
2020-06-12 14:04     ` Ludovic Courtès
2020-06-13  6:44       ` Eli Zaretskii
2020-06-13 15:04         ` Ludovic Courtès
2020-06-15 15:14           ` [PATCH v2 0/2] Add support for Guile 3.0 and 2.2 Ludovic Courtès
2020-06-15 15:14             ` [PATCH v2 1/2] guile: Add support for Guile 2.2 Ludovic Courtès
2020-06-15 17:00               ` Eli Zaretskii
2020-06-18 20:31                 ` Tom Tromey
2020-06-19  6:08                   ` Eli Zaretskii
2020-06-19  7:37                     ` Ludovic Courtès
2020-06-26  8:13                       ` [PATCH v3 0/2] Add support for Guile 3.0 and 2.2 Ludovic Courtès
2020-06-26  8:13                         ` [PATCH v3 1/2] guile: Add support for Guile 2.2 Ludovic Courtès
2020-06-26 10:23                           ` Eli Zaretskii [this message]
2020-06-28 14:20                             ` Ludovic Courtès
2020-06-28 14:25                               ` [PATCH v4 " Ludovic Courtès
2020-06-28 16:40                                 ` Eli Zaretskii
2020-07-03  0:31                                 ` Simon Marchi
2020-07-03  7:06                                   ` Ludovic Courtès
2020-07-18 19:00                                   ` Joel Brobecker
2020-07-19 15:45                                     ` Simon Marchi
2020-07-20  8:05                                       ` Ludovic Courtès
2020-07-20 15:01                                         ` Simon Marchi
2020-07-21 21:10                                           ` Ludovic Courtès
2020-06-28 14:25                               ` [PATCH v4 2/2] guile: Add support for Guile 3.0 Ludovic Courtès
2020-06-28 16:38                               ` [PATCH v3 1/2] guile: Add support for Guile 2.2 Eli Zaretskii
2020-06-28 16:51                                 ` Ludovic Courtès
2020-07-02 12:57                               ` [PING] Add support for Guile 2.2/3.0 Ludovic Courtès
2020-07-13 15:36                                 ` Tom Tromey
2020-06-26  8:13                         ` [PATCH v3 2/2] guile: Add support for Guile 3.0 Ludovic Courtès
2020-06-26 10:13                           ` Eli Zaretskii
2020-06-15 15:14             ` [PATCH v2 " Ludovic Courtès
2020-06-12 14:14   ` [PATCH 1/2] guile: Add support for Guile 2.2 Tom de Vries
2020-06-12 14:36     ` Ludovic Courtès
2020-06-12 13:27 ` [PATCH 2/2] guile: Add support for Guile 3.0 Ludovic Courtès
2020-06-15 15:02   ` Tom Tromey
2020-06-15 15:17     ` Ludovic Courtès
2020-06-17 16:58     ` Ludovic Courtès
2020-06-17 17:21       ` Eli Zaretskii

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

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

  git send-email \
    --in-reply-to=83a70qruqp.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=ludo@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).