[Bug c/107653] New: how-to-use-inline-assembly-language-in-c-code page is huge and should be split up

[Bug c/107653] New: how-to-use-inline-assembly-language-in-c-code page is huge and should be split up

[pinskia at gcc dot gnu.org]

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

            Bug ID: 107653
           Summary: how-to-use-inline-assembly-language-in-c-code page is
                    huge and should be split up
           Product: gcc
           Version: 13.0
            Status: UNCONFIRMED
          Keywords: documentation, inline-asm
          Severity: normal
          Priority: P3
         Component: c
          Assignee: unassigned at gcc dot gnu.org
          Reporter: pinskia at gcc dot gnu.org
  Target Milestone: ---

https://gcc.gnu.org/onlinedocs/gcc/extensions-to-the-c-language-family/how-to-use-inline-assembly-language-in-c-code.html
really needs to split up into many different pages.

Compared to
https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/Using-Assembly-Language-with-C.html#Using-Assembly-Language-with-C 

Having smaller pages is very useful, especially when you are going to just look
at target constraints (which was a huge page even for texinfo generated
documents):
https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/Machine-Constraints.html#Machine-Constraints

having all information on inline-asm on one page makes it hard to figure out
things even with the right side bar. The seperate pages of the texinfo
generated files makes it easier to navigate especially to the specific topic
you want to navigate to.  Having a TOC page for each section is very very
useful; the side bar only goes so far of describing things.


Note I have not double checked to make sure that the internals document and the
user manual are shared or not here plus disabling of some of the constraints
for the user manual either.

[Bug c/107653] how-to-use-inline-assembly-language-in-c-code page is huge and should be split up

[pinskia at gcc dot gnu.org]

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

--- Comment #1 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
I thought it went one layer deap but nope it is kinda of random.
For an example:
Not split up:
https://gcc.gnu.org/onlinedocs/gccint/target-macros/register-classes.html

Splitted up:
https://gcc.gnu.org/onlinedocs/gccint/target-macros/stack-layout-and-calling-conventions.html

Both are on the same level and both have similar amount of information on each
section as far as I can tell.

Does anyone understand how it was decided to split it up vs not splitting up?

[Bug c/107653] how-to-use-inline-assembly-language-in-c-code page is huge and should be split up

[pinskia at gcc dot gnu.org]

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

--- Comment #2 from Andrew Pinski <pinskia at gcc dot gnu.org> ---
(In reply to Andrew Pinski from comment #1)
> I thought it went one layer deap but nope it is kinda of random.
> For an example:
> Not split up:
> https://gcc.gnu.org/onlinedocs/gccint/target-macros/register-classes.html
> 
> Splitted up:
> https://gcc.gnu.org/onlinedocs/gccint/target-macros/stack-layout-and-calling-
> conventions.html
> 
> Both are on the same level and both have similar amount of information on
> each section as far as I can tell.
> 
> Does anyone understand how it was decided to split it up vs not splitting up?

Sorry I copied the wrong one which was not split up.
I Mean
https://gcc.gnu.org/onlinedocs/gccint/target-macros/register-usage.html#

Also the left side bar has an arrow next to that one but it expands to nothing.

[Bug c/107653] how-to-use-inline-assembly-language-in-c-code page is huge and should be split up

[marxin at gcc dot gnu.org]

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

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

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

--- Comment #3 from Martin Liška <marxin at gcc dot gnu.org> ---
Confirmed, the shared doc/md.rst file is shared in between gcc and gccint
manual, where md.rst contains many '  .. only:: gccint' directives.

But yes, we should split it a bit.

[Bug c/107653] how-to-use-inline-assembly-language-in-c-code page is huge and should be split up

[marxin at gcc dot gnu.org]

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

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

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |WONTFIX
             Status|ASSIGNED                    |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.