Open adonovan opened 2 weeks ago
Similar Issues
(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)
I would like know to run go doc -http
, which starts a pkgsite process and opens a browser, then waits for the syscall.SIGINT
signal, and when it receives the signal, first close the pkgsite process and then exit itself ,how?
We could certainly make go doc -http
block until interrupted before terminating the server. And perhaps that's the least surprising interface, as many Go commands that take an -http flag block indefinitely.
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