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

x/tools/cmd/godoc: document as deprecated #49212

Closed
jba opened this issue Oct 28, 2021 · 3 comments
Closed

x/tools/cmd/godoc: document as deprecated #49212

jba opened this issue Oct 28, 2021 · 3 comments
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@jba
Copy link
Contributor

jba commented Oct 28, 2021

Document this program as deprecated, and point users to golang.org/x/pkgsite/cmd/pkgsite.

@jba jba added the Tools This label describes issues relating to any tools in the x/tools repository. label Oct 28, 2021
@jba jba self-assigned this Oct 28, 2021
@gopherbot gopherbot added this to the Unreleased milestone Oct 28, 2021
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/349051 mentions this issue: cmd/godoc: deprecate and point to cmd/pkgsite

@dmitshur dmitshur added the NeedsFix The path to resolution is known, but the work has not been done. label Oct 28, 2021
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/367014 mentions this issue: cmd/godoc: remove extra // characters from deprecation notice

gopherbot pushed a commit to golang/tools that referenced this issue Nov 24, 2021
The comment is already inside a /* */ block, so no need for //.

Updates golang/go#49212.

Change-Id: I6d50cedab363ed312d85e66797cbc4f652e56dab
Reviewed-on: https://go-review.googlesource.com/c/tools/+/367014
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Trust: Dmitri Shuralyov <dmitshur@golang.org>
@rsc rsc unassigned jba Jun 23, 2022
@derCodemeister
Copy link

I do not think that godoc should be deprecated. It serves a different purpose from pkgsite.
I use godoc as a local webserver for the documentation to my unpublished packages and as a reference for the go standard library. I do not want a local copy of the go.dev website. pkgsite also assumes you have a working internet connection, since all links but pkg-search connect to go.dev, while godoc is completely local. With pkgsite I have to know what I am looking for, since there is no index of the packages in the standard lib. Also a local pkgsite seems to me to be quite unrealiable. After
go install golang.org/x/pkgsite/cmd/pksite@latest it claimed to be installed, but just does not work. The website comes up at port 8080, but all searches fail.
Hence I am wondering why a working program is supposed to be replaced by some much more unreliable and fragile piece of software that does not even cover the use cases of the orignal software. Also pkgsite has way too many dependieces which are not used at all in a local setup - this makes the software much more fragile and also increases its size by a factor of 4. I am wondering how this holds up to gos principle of simplicity. godoc serves a simple purpose, pkgsite does not. I consider local use of pkgsite wrong and against the principles of go.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

5 participants