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

Jump to bottom

x/tools/godoc: Not all subrepos listed. #24432

Closed
dmitshur opened this issue Mar 16, 2018 · 3 comments
Closed

x/tools/godoc: Not all subrepos listed. #24432

dmitshur opened this issue Mar 16, 2018 · 3 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@dmitshur
Copy link
Contributor

dmitshur commented Mar 16, 2018 •
edited

This is a 2018 edition of issue #9081.

In #14304, a new x/perf subrepo was proposed and created. I noticed it wasn't listed at https://golang.org/pkg/#subrepo, and the feedback was that it should be added.

I also noticed that x/time subrepo was missing and filed #24430 for that, which got labeled with NeedsFix.

While working on a trivial fix, I realized there are even more subrepos not listed. The list of subrepos, as determined by the source code for the /x/ handler, is:

var xMap = map[string]xRepo{
	"codereview": {"https://code.google.com/p/go.codereview", "hg"},

	"arch":       {"https://go.googlesource.com/arch", "git"},
	"benchmarks": {"https://go.googlesource.com/benchmarks", "git"},
	"blog":       {"https://go.googlesource.com/blog", "git"},
	"build":      {"https://go.googlesource.com/build", "git"},
	"crypto":     {"https://go.googlesource.com/crypto", "git"},
	"debug":      {"https://go.googlesource.com/debug", "git"},
	"exp":        {"https://go.googlesource.com/exp", "git"},
	"image":      {"https://go.googlesource.com/image", "git"},
	"lint":       {"https://go.googlesource.com/lint", "git"},
	"mobile":     {"https://go.googlesource.com/mobile", "git"},
	"net":        {"https://go.googlesource.com/net", "git"},
	"oauth2":     {"https://go.googlesource.com/oauth2", "git"},
	"perf":       {"https://go.googlesource.com/perf", "git"},
	"playground": {"https://go.googlesource.com/playground", "git"},
	"review":     {"https://go.googlesource.com/review", "git"},
	"sync":       {"https://go.googlesource.com/sync", "git"},
	"sys":        {"https://go.googlesource.com/sys", "git"},
	"talks":      {"https://go.googlesource.com/talks", "git"},
	"term":       {"https://go.googlesource.com/term", "git"},
	"text":       {"https://go.googlesource.com/text", "git"},
	"time":       {"https://go.googlesource.com/time", "git"},
	"tools":      {"https://go.googlesource.com/tools", "git"},
	"tour":       {"https://go.googlesource.com/tour", "git"},
	"vgo":        {"https://go.googlesource.com/vgo", "git"},
}

It's not clear to me whether absolutely all of them should be listed or not. This issue is about determining that.

Once a decision is made about which missing repos should be listed, the missing repos can either be manually added (as was done before in golang/tools@06e42bd), or, alternatively, we can consider reworking the xMap to serve both as a source for the /x/ handler as well as a list of subrepos that are displayed by godoc.
@gopherbot gopherbot added this to the Unreleased milestone Mar 16, 2018
This was referenced Mar 16, 2018
Closed
Closed
@ALTree ALTree added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Mar 19, 2018
@spf13
Copy link
Contributor

spf13 commented Mar 26, 2018

@shurcooL please send a CL with the addition of perf, review, sync, and time.

We don't need to make this automatically generated as we infrequently add repos and many are more internal or experimental and shouldn't be included in the list.

@spf13 spf13 closed this as completed Mar 26, 2018
@rsc rsc reopened this Mar 26, 2018
@rsc rsc added the NeedsFix The path to resolution is known, but the work has not been done. label Mar 26, 2018
@gopherbot gopherbot removed the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Mar 26, 2018
@dmitshur
Copy link
Contributor Author

dmitshur commented Mar 28, 2018 •
edited

a CL with the addition of perf, review, sync, and time.

Ok, on it now.

We don't need to make this automatically generated as we infrequently add repos

That's fair.

many are more internal or experimental and shouldn't be included in the list.

Can we add a comment stating that then? Otherwise, it's unclear if a repo is not included because it's a bug, or because it's considered internal and its omission is intentional.

I can add the comments in my CL, it'll be easy to review. Edit: See CL 103075.

I'm a bit surprised that we don't want to add oauth2, I thought golang.org/x/oauth2 was a pretty popular subrepo (it has over 3000 public importers). I'm okay with it, just wanted to point it out.

@dmitshur dmitshur self-assigned this Mar 28, 2018
@gopherbot
Copy link

Change https://golang.org/cl/103075 mentions this issue: godoc/static: add perf, review, sync subrepos

@dmitshur dmitshur removed their assignment Mar 28, 2018
@golang golang locked and limited conversation to collaborators Mar 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
5 participants
@rsc @spf13 @dmitshur @ALTree @gopherbot