diff mbox

Fix DEFHOOKPOD argument order in target-hooks-macros.h comment

Message ID 53582931.5@mentor.com
State New
Headers show

Commit Message

Tom de Vries April 23, 2014, 8:57 p.m. UTC
Joern,

target-hooks-macros.h shows an argument order of DOC, TYPE, NAME, INIT for 
DEFHOOKPOD in a comment:
...
    DEFHOOKPOD(DOC, TYPE, NAME, INIT): Define a piece-of-data 'hook'.
...

But the first DEFHOOKPOD that I see in target.def:
...
DEFHOOKPOD
(atomic_test_and_set_trueval,
  "This value should be set if the result written by\
  @code{atomic_test_and_set} is not exactly 1, i.e. the\
  @code{bool} @code{true}.",
  unsigned char, 1)
...
seems to have the order NAME, DOC, TYPE, INIT.

target.def is the only file to include target-hooks-macros.h, but other defines 
of DEFHOOKPOD in target.h:
...
#define DEFHOOKPOD(NAME, DOC, TYPE, INIT) TYPE NAME;
...
and genhooks.c:
...
#define DEFHOOKPOD(NAME, DOC, TYPE, INIT) \
...
use the the same order.

I'd say that confirms that the argument order for DEFHOOKPOD in the comment in 
target-hooks-macros.h is wrong.

This patch fixes that. I'll commit shortly, as obvious.

Thanks,
- Tom

2014-04-23  Tom de Vries  <tom@codesourcery.com>

	* target-hooks-macros.h: Fix DEFHOOKPOD argument order in comment.
diff mbox

Patch

diff --git a/gcc/target-hooks-macros.h b/gcc/target-hooks-macros.h
index 5cf4cb1..901f824 100644
--- a/gcc/target-hooks-macros.h
+++ b/gcc/target-hooks-macros.h
@@ -18,7 +18,7 @@ 
 /* The following macros should be provided by the including file:
 
    DEFHOOK(NAME, DOC, TYPE, PARAMS, INIT): Define a function-valued hook.
-   DEFHOOKPOD(DOC, TYPE, NAME, INIT): Define a piece-of-data 'hook'.  */
+   DEFHOOKPOD(NAME, DOC, TYPE, INIT): Define a piece-of-data 'hook'.  */
 
 /* Defaults for optional macros:
    DEFHOOKPODX(NAME, TYPE, INIT): Like DEFHOOKPOD, but share documentation