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, cmd/link: doc: docs are incomplete #26533

Open
ainar-g opened this Issue Jul 22, 2018 · 3 comments

Comments

Projects
None yet
4 participants
@ainar-g
Contributor

ainar-g commented Jul 22, 2018

The documentation for those commands on the website (compile, link) lacks certain flags. For example, compile's page is missing the very useful -m flag, and link's page -- -a, -buildid, and others.

(Ideally, those sections would be generated from go tool (compile|link) -h output, but I don't know enough details to propose a full solution.)

@ianlancetaylor ianlancetaylor changed the title from doc: go tool (compile|link) docs on the site are incomplete to cmd/compile, cmd/link: doc: docs are incomplete Aug 3, 2018

@ianlancetaylor

This comment has been minimized.

Contributor

ianlancetaylor commented Aug 3, 2018

I don't think we should generate the docs from the -h output. The docs and the -h output serve two different purposes.

@hellozee

This comment has been minimized.

Contributor

hellozee commented Aug 9, 2018

I would love to take a shot on it, but first I need to what things I need to add? would just adding the missing flags, do the task?

@gopherbot

This comment has been minimized.

gopherbot commented Oct 1, 2018

Change https://golang.org/cl/138757 mentions this issue: cmd: add document for some missing flags in cmd/compile and cmd/link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment