Re: -symbol-list-lines doco update

Eli Zaretskii
2004-02-17T19:23:15Z

> Date: Tue, 17 Feb 2004 10:43:39 -0500
> From: Bob Rossi <bob@brasko.net>
>
> This documents several of the special case's that -symbol-list-lines
> outputs.

Thanks. I have several comments about your Texinfo usage.

> +There are two interesting points to be mentioned here.
> +
> +- The line number can be returned as "0". The line number "0" means

Please use "@itemize @minus" and "@item" here, like this:

There are two interesting points to be mentioned here.

@itemize @minus
@item
The line number can be returned as ``0''. The line number ``0'' means

etc., I hope you get the point. The Texinfo translators, like
makeinfo and TeX, will then take care of producing the "-" before
every @item, and will also indent the list so it looks pretty.

Note two other changes I made in the original text: "0" should be
``0'', and there should be 2 blanks after each period that ends a
sentence. These are basic rules of Texinfo and should be observed
throughout.

> +For example, PCs greater than 0x8048406 that
> +don't have a new starting line do not belong to this line number table.

This sentence is confusing, I think: if I were a programmer of a front
end, I'd have hard time understanding what it means. What ``line
number table'' are we talking about, and what does it mean that a PC
value ``does not belong'' to it? Also, ``don't have a new starting
line'' is unclear, at least to me.

> +Duplicated line numbers are emitted by the compiler to mark, mostly,
> +the ends of prologues.

I think there's another noteworthy case where this happens: when
optimizations cause the code produced for some line be scattered
among the PC values.

Thanks again for taking time to write this up.