-
Notifications
You must be signed in to change notification settings - Fork 17.4k
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
proposal: cmd/go: doc -http should start a pkgsite instance and open a browser #68106
Comments
Similar Issues
(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.) |
I would like know to run |
We could certainly make |
The
go doc
command displays documentation to stdout, which is handy for quick forays for a single package or symbol, but for extended reading a browser is more convenient, as it has better typography and linked cross-references. We propose thatgo doc -http
should start a pkgsite instance in the background (if one is not running already) and open a web browser to the correct URL for the package or symbol.The pkgsite program is currently rather large and slow to start as it was designed as a long-lived server for a large corpus on Google Cloud. Issue #61399 tracks the work so slim it down and reduce dependencies.
Open questions:
go doc
processes communicate the port or pid of the running instance, and deal with server crashes?@rsc @matloob
The text was updated successfully, but these errors were encountered: