Re: [PATCHv2 7/8] gdb/doc: add some notes on selecting suitable attribute names

[Eli Zaretskii <eliz@gnu.org>]

> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Wed, 10 Jan 2024 15:54:44 +0000
> 
> In previous commits I've added Object.__dict__ support to gdb.Inferior
> and gdb.InferiorThread, this is similar to the existing support for
> gdb.Objfile and gdb.Progspace.
> 
> This commit extends the documentation to offer the user some guidance
> on selecting good names for their custom attributes so they
> can (hopefully) avoid conflicting with any future attributes that GDB
> might add.
> 
> The rules I've proposed are:
> 
>   1. Don't start user attributes with a lower case letter, all the
>   current GDB attributes start with a lower case letter, and I suspect
>   all future attributes would also start with a lower case letter, and
> 
>   2. Don't start user attributes with a double underscore, this risks
>   conflicting with Python built in attributes (e.g. __dict__) - though
>   clearly the user would need to start and end with a double
>   underscore, but it seemed easier just to say no double underscores.
> 
> I'm doing this as a separate commit as I've updated the docs for the
> existing gdb.Objfile and gdb.Progspace so they all reference a single
> paragraph on selecting attribute names.
> ---
>  gdb/doc/python.texi | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)

Thanks.

> +See @ref{choosing attribute names} for guidance on selecting a

Why not @xref?  And please add a comma after the right brace, there
are still old versions of Texinfo that insist on that.

> +See @ref{choosing attribute names} for guidance on selecting a
> +suitable name for new attributes.

Likewise.

> +See @ref{choosing attribute names} for guidance on selecting a
> +suitable name for new attributes.

And likewise.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>