Re: [PATCH] Add support for embedding scripts in .debug_gdb_scripts.

[Doug Evans <xdje42 at gmail dot com>]

On Thu, Jan 15, 2015 at 10:11 AM, Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Doug Evans <xdje42@gmail.com>
>> Date: Thu, 15 Jan 2015 09:31:48 -0800
>>
>> +* Python/Guile scripting
>> +
>> +** GDB now supports auto-loading of Python/Guile scripts contained in the
>> +   special section named `.debug_gdb_scripts'.
>
> I think we should tell here on what systems/targets this is supported.
> Otherwise, the NEWS entry is OK.

The previous news entry didn't, and I'm following that.

>>  For systems using file formats like ELF and COFF,
>>  when @value{GDBN} loads a new object file
>>  it will look for a special section named @code{.debug_gdb_scripts}.
>
> Is this really supported with non-ELF targets?  E.g., does pe-coff
> (Windows) support such sections?

My mingw32 toolchain generates DWARF
(i.e., has .debug_* sections).

>> +If this section exists, its contents is a list of NUL-terminated entries
>> +specifying scripts to load.  Each entry begins with a non-NULL prefix byte that
>
> Let's be consistent here" "null", lower-case and with 2 'l'.  This is
> just a plain English word, not an acronym or a C symbol.

NULL is a typo, thanks for catching that.
I'm just following usage elsewhere in gdb.texinfo,
and I like this choice.

>
>> +Supported values for the prefix byte are define in the
>                                             ^^^^^^
> "defined"

Done.

>
>> +@file{include/gdb/section-scripts.h} file in the @value{GDBN} source tree.
>
> Is this really helpful?  If that file is installed, let's mention
> where to find it in the installed tree; if it is not installed, we
> ought to list the values here, since the reader might not have access
> to the source tree, let alone the one from which the binary was
> produced.
>
>> +The following entries are supported:
>> +
>> +@table @code
>> +@item SECTION_SCRIPT_ID_PYTHON_FILE = 1
>> +@item SECTION_SCRIPT_ID_SCHEME_FILE = 3
>> +@item SECTION_SCRIPT_ID_PYTHON_TEXT = 4
>> +@item SECTION_SCRIPT_ID_SCHEME_TEXT = 6
>> +@end table
>
> Are these the values of the prefix byte?  If so, we should simply skip
> the pointer to the source tree.

Done.

>
>> +@subsubsection Script Text Entries
>> +
>> +In script text entries the script to execute is contained in the entry
>> +instead of being loaded from a file.
>
> Suggest to reword this sentence:
>
>   Script text entries allow to put the executable script in the entry
>   itself instead of loading it from a file.

Done.

>
>> +The rest of the entry, up to the trailing NUL byte,
>                                              ^^^
> "null"

Copied from gdb.texinfo.
Plus we've had this conversation before. :-)

https://sourceware.org/ml/gdb-patches/2013-12/msg00892.html
https://sourceware.org/ml/gdb-patches/2013-12/msg00894.html

>
>>                                                      is the script to
>> +execute in the specified language.
>
> Specified how and by what means?
>
>> +Loading of inlined scripts require a properly configured
>                               ^^^^^^^
> "requires"

Done.

Attachment: embedded-scripts-2.patch.txt
Description: Text document