On 12/4/23 00:36, Jakub Jelinek wrote:
On Fri, Dec 01, 2023 at 10:43:57AM -0700, Sandra Loosemore wrote:
On 12/1/23 10:33, Jakub Jelinek wrote:
Shall we tweak that somehow? If the argument names are unimportant, perhaps
it is fine to leave that out, but shouldn't we always use @var{...} around
the parameter names when specified?
Yup. The Texinfo manual says: "When using @deftypefn command and
variations, you should mark parameter names with @var to distinguish these
from data type names, keywords, and other parts of the literal syntax of the
programming language."
Here is a patch which does that (but not adding types to where they were
missing, that will be harder to search for).
Bootstrapped/regtested on x86_64-linux and i686-linux, ok for trunk?
This is mostly OK, but I noticed some things you missed:
@@ -12946,13 +12946,13 @@ and @code{__ATOMIC_CONSUME}.
@enddefbuiltin
-@defbuiltin{void __atomic_load (@var{type} *ptr, @var{type} *ret, int memorder)}
+@defbuiltin{void __atomic_load (@var{type} *@var{ptr}, @var{type} *ret, int
@var{memorder})}
@var markup on "ret" here.
-@defbuiltin{void __atomic_store_n (@var{type} *ptr, @var{type} val, int
memorder)}
+@defbuiltin{void __atomic_store_n (@var{type} *@var{ptr}, @var{type} val, int
@var{memorder})}
And on "val" here...
-@defbuiltin{void __atomic_store (@var{type} *ptr, @var{type} *val, int
memorder)}
+@defbuiltin{void __atomic_store (@var{type} *@var{ptr}, @var{type} *val, int
@var{memorder})}
...and here...
-@defbuiltin{@var{type} __atomic_exchange_n (@var{type} *ptr, @var{type} val,
int memorder)}
+@defbuiltin{@var{type} __atomic_exchange_n (@var{type} *@var{ptr}, @var{type}
val, int @var{memorder})}
...and here.
-@defbuiltin{void __atomic_exchange (@var{type} *ptr, @var{type} *val,
@var{type} *ret, int memorder)}
+@defbuiltin{void __atomic_exchange (@var{type} *@var{ptr}, @var{type} *val,
@var{type} *ret, int @var{memorder})}
And both "val" and "ret" here.
OK with those things fixed.
-Sandra
