Re: [committed] jit: further doc fixes

[Eric Gallager <egall@gwmail.gwu.edu>]

On Fri, Apr 1, 2022 at 9:28 AM David Malcolm via Gcc-patches
<gcc-patches@gcc.gnu.org> wrote:
>
> Further jit doc fixes, which fix links to
> gcc_jit_function_type_get_param_type and gcc_jit_struct_get_field.
>
> I also regenerated libgccjit.texi (not included in the diff below).
>
> Tested with "make html" and with a bootstrap.

 Could you test with `make pdf` and `make dvi` too, to see if this fixes 102824?
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

> Committed to trunk as r12-7959-g1a172da8a3f362.
>
> gcc/jit/ChangeLog:
>         * docs/topics/expressions.rst: Fix formatting.
>         * docs/topics/types.rst: Likewise.
>         * docs/_build/texinfo/libgccjit.texi: Regenerate
>
> Signed-off-by: David Malcolm <dmalcolm@redhat.com>
> ---
>  gcc/jit/docs/topics/expressions.rst | 8 ++++----
>  gcc/jit/docs/topics/types.rst       | 6 +++---
>  2 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/gcc/jit/docs/topics/expressions.rst b/gcc/jit/docs/topics/expressions.rst
> index 9267b6d2ad6..d51264af73f 100644
> --- a/gcc/jit/docs/topics/expressions.rst
> +++ b/gcc/jit/docs/topics/expressions.rst
> @@ -24,7 +24,7 @@ Rvalues
>  -------
>  .. type:: gcc_jit_rvalue
>
> -A :c:type:`gcc_jit_rvalue *` is an expression that can be computed.
> +A :c:type:`gcc_jit_rvalue` is an expression that can be computed.
>
>  It can be simple, e.g.:
>
> @@ -602,7 +602,7 @@ Function calls
>                gcc_jit_rvalue_set_bool_require_tail_call (gcc_jit_rvalue *call,\
>                                                           int require_tail_call)
>
> -   Given an :c:type:`gcc_jit_rvalue *` for a call created through
> +   Given an :c:type:`gcc_jit_rvalue` for a call created through
>     :c:func:`gcc_jit_context_new_call` or
>     :c:func:`gcc_jit_context_new_call_through_ptr`, mark/clear the
>     call as needing tail-call optimization.  The optimizer will
> @@ -721,8 +721,8 @@ where the rvalue is computed by reading from the storage area.
>
>        #ifdef LIBGCCJIT_HAVE_gcc_jit_lvalue_set_tls_model
>
> -.. function:: void
> -              gcc_jit_lvalue_set_link_section (gcc_jit_lvalue *lvalue,
> +.. function:: void\
> +              gcc_jit_lvalue_set_link_section (gcc_jit_lvalue *lvalue,\
>                                                 const char *section_name)
>
>     Set the link section of a variable.
> diff --git a/gcc/jit/docs/topics/types.rst b/gcc/jit/docs/topics/types.rst
> index 9779ad26b6f..c2082c0ef3e 100644
> --- a/gcc/jit/docs/topics/types.rst
> +++ b/gcc/jit/docs/topics/types.rst
> @@ -192,7 +192,7 @@ A compound type analagous to a C `struct`.
>
>  A field within a :c:type:`gcc_jit_struct`.
>
> -You can model C `struct` types by creating :c:type:`gcc_jit_struct *` and
> +You can model C `struct` types by creating :c:type:`gcc_jit_struct` and
>  :c:type:`gcc_jit_field` instances, in either order:
>
>  * by creating the fields, then the structure.  For example, to model:
> @@ -375,7 +375,7 @@ Reflection API
>       Given a function type, return its number of parameters.
>
>  .. function::  gcc_jit_type *\
> -               gcc_jit_function_type_get_param_type (gcc_jit_function_type *function_type,
> +               gcc_jit_function_type_get_param_type (gcc_jit_function_type *function_type,\
>                                                       size_t index)
>
>       Given a function type, return the type of the specified parameter.
> @@ -417,7 +417,7 @@ Reflection API
>       alignment qualifiers.
>
>  .. function::  gcc_jit_field *\
> -               gcc_jit_struct_get_field (gcc_jit_struct *struct_type,
> +               gcc_jit_struct_get_field (gcc_jit_struct *struct_type,\
>                                           size_t index)
>
>       Get a struct field by index.
> --
> 2.26.3
>