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

Closed
ainar-g opened this issue Jul 22, 2018 · 7 comments
Closed

cmd/compile, cmd/link: doc: docs are incomplete #26533

ainar-g opened this issue Jul 22, 2018 · 7 comments

Comments

@ainar-g
Copy link
Contributor

@ainar-g 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 doc: go tool (compile|link) docs on the site are incomplete cmd/compile, cmd/link: doc: docs are incomplete Aug 3, 2018
@ianlancetaylor

This comment has been minimized.

Copy link
Contributor

@ianlancetaylor 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.

Copy link
Contributor

@hellozee 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.

Copy link

@gopherbot 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

@agnivade

This comment has been minimized.

Copy link
Contributor

@agnivade agnivade commented Jan 7, 2019

@hellozee - The person who submitted the CL has not responded. You could look into that, incorporate @ianlancetaylor's comments and send a new CL.

@odeke-em

This comment has been minimized.

Copy link
Member

@odeke-em odeke-em commented Jan 20, 2019

Hello @yohei-takeda, Go1.12's release is just around the corner. Would you mind responding to Ian's comments on the CL? Thank you.

@gopherbot gopherbot closed this in 8b7cf89 Jan 25, 2019
@yo-tak

This comment has been minimized.

Copy link
Contributor

@yo-tak yo-tak commented Jan 25, 2019

Hello @ianlancetaylor @odeke-em , thank you so much for your feedbacks! And I'm very sorry I didn't respond for a long time.
I'm proud that I made my first commit to Go, I'll try to do better next time.

@ianlancetaylor

This comment has been minimized.

Copy link
Contributor

@ianlancetaylor ianlancetaylor commented Jan 25, 2019

@yo-tak No worries, thanks for taking the time to fix this.

@golang golang locked and limited conversation to collaborators Jan 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
You can’t perform that action at this time.