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: [RFA/doco] Document task-specific breakpoints


> In general, it is not a very good idea to have several
> cross-references to close in the same sentence.  Something like the
> following might be better:
> 
>   @xref{Thread-Specific Breakpoints}, for more about this.  For
>   Ada-specific aspects, see @ref{Ada Tasks}.

I agree with what you are saying, except that I think that the actual
suggestion does not flow well with the way the paragraph is written.
Currently, we have:

    It is also possible to insert a breakpoint that will stop the program
    only if a specific thread or a specific task hits that breakpoint.
    @xref{Thread-Specific Breakpoints} and @ref{Ada Tasks} for more
    information about this feature.

Basically, we say: thread-specific breakpoint, or task-specific
breakpoint.  Then xref thread-specific. Then xref task-specific.
Perhaps it'd be better to move the reference links to where the actual
reference is. But I couldn't find a way that satisfied me either.

So I propose the following in the end:

    It is also possible to insert a breakpoint that will stop the program
    only if a specific thread or a specific task hits that breakpoint.
    @xref{Thread-Specific Breakpoints}, and @ref{Ada Tasks}, for more
    information about this feature.

(adding the coma after each ref).

WDYT?

Thanks,
-- 
Joel


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