public inbox for gcc-bugs@sourceware.org
help / color / mirror / Atom feed
From: "pinskia at gcc dot gnu.org" <gcc-bugzilla@gcc.gnu.org>
To: gcc-bugs@gcc.gnu.org
Subject: [Bug c/107738] New: Top-level inline-asm is not well documented
Date: Thu, 17 Nov 2022 19:40:42 +0000	[thread overview]
Message-ID: <bug-107738-4@http.gcc.gnu.org/bugzilla/> (raw)

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

            Bug ID: 107738
           Summary: Top-level inline-asm is not well documented
           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: ---

There is only one reference to the top-level inline-asm in the whole user
manual:
https://gcc.gnu.org/onlinedocs/gcc-12.2.0/gcc/Basic-Asm.html#Basic-Asm


There should be a section here talking about common mistakes using top-level
inline-asm including but not limited to:
* assuming the section and alignment where the top-level inline-asm will be
emitted to
** Give examples on how to do push/pop section or using previous_section
*** make a mention this is depdent on the assembler being used
* assuming the order (reference also -fno-toplevel-reorder option) compared to
functions
* Give examples of other types of top-level inline-asm usage
* Make a mention of a limitation dealing with them and LTO and the reason why
you should avoid them and use other ways of doing the same thing instead

             reply	other threads:[~2022-11-17 19:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-17 19:40 pinskia at gcc dot gnu.org [this message]
2022-11-17 19:56 ` [Bug c/107738] " pinskia at gcc dot gnu.org
2022-12-04  5:38 ` pinskia at gcc dot gnu.org

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bug-107738-4@http.gcc.gnu.org/bugzilla/ \
    --to=gcc-bugzilla@gcc.gnu.org \
    --cc=gcc-bugs@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).