[Bug middle-end/107656] New: post sphinx conversion, can't tell between a target macro or a target hook

[Bug middle-end/107656] New: post sphinx conversion, can't tell between a target macro or a target hook

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107656

            Bug ID: 107656
           Summary: post sphinx conversion, can't tell between a target
                    macro or a target hook
           Product: gcc
           Version: 13.0
            Status: UNCONFIRMED
          Keywords: documentation
          Severity: normal
          Priority: P3
         Component: middle-end
          Assignee: unassigned at gcc dot gnu.org
          Reporter: pinskia at gcc dot gnu.org
            Blocks: 107655
  Target Milestone: ---

https://gcc.gnu.org/onlinedocs/gccint/target-macros/storage-layout.html
https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gccint/Storage-Layout.html#Storage-Layout

For an example PROMOTE_MODE, in the texinfo version, it has:
Macro: PROMOTE_MODE (m, unsignedp, type)

while for TARGET_C_EXCESS_PRECISION:
Target Hook: enum flt_eval_method TARGET_C_EXCESS_PRECISION (enum
excess_precision_type type)


But in the sphinx version, it does not list if it was a macro or a hook. Which
makes these confusing of what each is.


Referenced Bugs:

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107655
[Bug 107655] [meta-bug] tracker bug for issues encountered in the
texinfo-to-sphinx migration

[Bug middle-end/107656] post sphinx conversion, can't tell between a target macro or a target hook

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107656

--- Comment #1 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
.. c:macro:: PROMOTE_MODE (m, unsignedp, type)

.. function:: enum flt_eval_method TARGET_C_EXCESS_PRECISION (enum
excess_precision_type type)

It is really hard to tell the difference in the generated page though;
especially since target macros and hooks can sometimes take arguments.

[Bug middle-end/107656] post sphinx conversion, can't tell between a target macro or a target hook

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107656

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
     Ever confirmed|0                           |1
             Status|UNCONFIRMED                 |NEW
                 CC|                            |marxin at gcc dot gnu.org
   Last reconfirmed|                            |2022-11-13

--- Comment #2 from Martin Liška <marxin at gcc dot gnu.org> ---
Yes, it's a small drawback. One can distinguish macros by missing return type,
but I can imagine adding a

.. note::

  Target macro

for such macros that have arguments. These w/o arguments are hopefully
distinguishable from hooks.

[Bug middle-end/107656] post sphinx conversion, can't tell between a target macro or a target hook

[pinskia at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107656

--- Comment #3 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
(In reply to Martin Liška from comment #2)
> Yes, it's a small drawback.

IT IS NOT A SMALL DRAWBACK. It is a huge one really. Especially when a new
developer is trying to write a backend, they can't figure out if it was a
target hook or a target macro one is. The return type is only part is not
described anywhere to say it is the difference either. Epsecially when reading
each of these sections seperately.

I only noticed this because I am going to try to improve the documentation on
some of these and this caught my eye and made me even more confused (I looked
at the new documentation first and I was wait isn't one a target hook and then
I had to go look at the previous texinfo documentation to see that was true).

[Bug middle-end/107656] post sphinx conversion, can't tell between a target macro or a target hook

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=107656

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |WONTFIX
             Status|NEW                         |RESOLVED

--- Comment #4 from Martin Liška <marxin at gcc dot gnu.org> ---
The Sphinx documentation has been reverted:
https://gcc.gnu.org/pipermail/gcc/2022-November/239983.html

Thus, I'm closing this as won't fix.