Re: [patch] [1/5] Types reference counting [base]

[Eli Zaretskii <eliz at gnu dot org>]

> Date: Sat, 11 Apr 2009 12:20:45 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> 
> a base implementation of types reference counting.

Thanks.

> gdb/doc/

Thanks, I have a few comments about this part of your patch.

> 2009-04-11  Jan Kratochvil  <jan.kratochvil@redhat.com>
> 
> 	* gdbint.texinfo (Symbol Handling): New anchor `Builtin Types'.  Move
> 	types `from Memory Management for Symbol Files' to a new subsection
> 	`Memory Management for Types'.

Please also add in the log an entry which explicitly says that `Memory
Management for Types' was added ("New node.").  See below.

> +@subsection Memory Management for Types

I'd prefer not to have sections without an associated @node.  Such a
manual is harder to navigate.  Please add a @node here.  That's
assuming that having a separate subsection here is justified; maybe it
isn't.

Also, a @cindex entry (with the same text as the subsection name, only
in lower case) would be useful here.

> +@code{TYPE_OBJFILE} macro indicates the current memory owner of the type.

It would be good to have a @findex entry for each macro you describe
(TYPE_OBJFILE etc.).

> +@code{TYPE_OBJFILE} set to @code{NULL} and become so called reclaimable types.

"so-called", with a dash, and I suggest a @dfn around "reclaimable
types", since you are introducing new terminology.

> +Types with @code{NULL TYPE_OBJFILE} can be either permanent types

Please don't put @code around several separate words, because that
causes the whitespace to be typeset incorrectly.  Please use a
separate @code for each word.

Actually, I'd reword this as

    Types with @code{TYPE_OBJFILE} set to @code{NULL} can be ..
or
    Types with null @code{TYPE_OBJFILE} can be ...

> +(@pxref{Builtin Types}) or reclaimable types which will be deallocated after the
> +last object referencing them is removed.

But the text below says that actually they will be deallocated only
when GDB becomes idle, right?

> +as through @code{TYPE_TARGET_TYPE}, @code{TYPE_POINTER_TYPE} etc. and prevents
                                                                   ^^
Please add either a @: or a comma after any period that doesn't end a
sentence, so that TeX would not typeset that as a sentence end.