-
Notifications
You must be signed in to change notification settings - Fork 18k
x/tools/godoc: Not all subrepos listed. #24432
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
Comments
@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. |
Ok, on it now.
That's fair.
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 |
Change https://golang.org/cl/103075 mentions this issue: |
They exist and are considered to be worth listing based on the decision made in golang/go#24432. They weren't listed previously. This change fixes that. Document the remaining subrepos that are not meant to be listed (per decision in golang/go#24432), so it's clear that it's intentional for them to not be visible at https://golang.org/pkg/#subrepo. Closes golang/go#24432. Updates golang/go#14304. Change-Id: Icc50ebfcdbc490c32519d92a1a838eb3f54c823d Reviewed-on: https://go-review.googlesource.com/103075 Reviewed-by: Austin Clements <[email protected]>
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:
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 bygodoc
.The text was updated successfully, but these errors were encountered: