Re: Summary: unreviewed hook doc patches

[Gerald Pfeifer <gerald at pfeifer dot com>]

I had another look at the list, and there is another one I can
review for you.

On Mon, 8 Feb 2010, Joern Rennecke wrote:
> TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD_SPEC
> http://gcc.gnu.org/ml/gcc-patches/2010-01/msg00793.html

 This hook is used as a workaround for
 @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD_GUARD} not being
 called on the first instruction of the ready list.  The hook is used to
 discard speculative instruction that stand first in the ready list from

Somehow this is not a proper sentence.  I see that this predates your
patch, but while we are at it...  "instructions" perhaps, or "a
speculative instruction that stands"?

-being scheduled on the current cycle.  For non-speculative instructions,
-the hook should always return nonzero.  For example, in the ia64 backend
+being scheduled on the current cycle.  If the hook returns @code{false} for the
+insn passed as the parameter, the insn will not be chosen to be issued.
+For non-speculative instructions,
+the hook should always return @code{true}.  For example, in the ia64 backend

Let's make this 

  If the hook returns @code{false}, @var{insn} will not be chosen to
  be issued.

or

  If the hook returns @code{false}, the insn under consideration will
  not be chosen to be used.

Okay?

One less in your queue... :-)

Gerald