This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Ping an old Python patch


> From: Tom Tromey <tom@tromey.com>
> Date: Mon, 30 Apr 2018 09:31:35 -0600
> 
> I think this patch:
> 
> https://sourceware.org/ml/gdb-patches/2015-05/msg00132.html
> 
> ... was never reviewed.

Oops!

> +@defun gdb.find_source_hook (source_file)
> +@anchor{find_source_hook}
> +
> +If @var{find_source_hook} is callable, @value{GDBN} will call the method
> +assigned to this operation when it cannot locate a requested source file.
> +
> +The parameter @code{source_file} contains the path to the source file

This should be the other way around: find_source_hook should be in
@code while source_file should be in @var.

> +This method must return a Python string or @code{None}.  If a string is
> +returned, it must be an absolute path to the source file.  If @code{None}
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
"absolute file name of the source file".  GNU coding standards frown
on using "path" for anything but PATH-style directory lists.

> +is returned, @value{GDBN} will proceed as usual without source. The path
                                                                 ^^
Two spaces between sentences.

The documentation part is approved with those nits fixed.

Thanks.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]