Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/compile: document go:noinline compiler directive #18049

Closed
hiltjo opened this issue Nov 25, 2016 · 2 comments
Closed

cmd/compile: document go:noinline compiler directive #18049

hiltjo opened this issue Nov 25, 2016 · 2 comments

Comments

@hiltjo
Copy link

hiltjo commented Nov 25, 2016

What version of Go are you using (go version)?

go-git (commit a2bd5c5) and 1.7.3

Issue

I noticed the go:noinline compiler directive is not documented on the page
https://golang.org/cmd/compile/ .

Fix

A patch is attached to fix it. The wording can probably be expanded and improved though.

https://cow.codemadness.org/go/patches/0001-cmd-compile-document-go-noinline-compiler-directive.patch

Edit: attaching patches on github sucks, so I made a link to the patch.

@0xmohit
Copy link
Contributor

0xmohit commented Nov 25, 2016

Please refer to Contributing Guidelines.

@ianlancetaylor
Copy link
Contributor

The go:noinline comment is only intended for testing the compiler. It is not intended for general use. Therefore, it is not documented in the user documentation. See the discussion at #12312.

(It would be nice if there were better internal documentation for the compiler, which is where this should be documented, but that is a separate issue.)

@golang golang locked and limited conversation to collaborators Nov 25, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants