Option to omit source code all together
alecthomas opened this issue · 24 comments
In very large repositories, I don't really want to include the source code again, I'd rather just link to the original source code files.
I realise this will require some level of heuristics for different source control hosters like GitHub, GitLab, etc.
This needs some time to implement but I think it is possible. I will notify you when it is done (or the idea is given up).
Thanks for the suggestion.
Where is your source code hosted? Is it sufficient to only support github and gitlab?
BTW, there is an obstacle that it is hard to detect the source hosts of third-party dependency packages. So the current implementation will only support external source code pages for standard packages and the current project packages.
I just found a way to find out the source hosts of third-party dependency packages. But this way needs external network connection. Is it acceptable in your use case?
For sure, along with some kind of caching perhaps? Either way would be great though!
Ah, maybe the host urls of the modules with github.com as import prefix could be possible to be guessed from their cache directory path. Though those modules with custom domain prefixes still need a https request to achieve the goal.
@alecthomas
I just pushed a commit which supports popular code hosting websites and Go packages.
It is appreciated if you could run it on your code to check if there are still problems.
Will do this week hopefully, I'll let you know. Thank you very much.
Tried it out and it vastly reduced the size of the output, thank you!
It does still appear to generate source for the module itself though, even though it's on GitHub. Is that intentional?
It is okay for my project, which is also hosted on Github.
I just pushed a new commit which will not panic for projects which are not git based. (unrelated to your last comment).
What are the outputs for the following 4 commands in your project directory?
git rev-parse --show-toplevel
git rev-parse HEAD
git rev-parse --abbrev-ref --symbolic-full-name @{upstream}
git remote get-url <the part before the slash of the output of the last command>
In my case, they are:
$ git rev-parse --show-toplevel
/home/myname/projects/go101/golds
$ git rev-parse HEAD
767f95dcac9fad16bc005d437d37b4b3fe823594
$ git rev-parse --abbrev-ref --symbolic-full-name @{upstream}
origin/develop
$ git remote get-url origin
https://github.com/go101/golds.git
My remote uses SSH because it's a private repo with an SSH based security model. It looks somewhat like this:
foo@github.com:/<user>/<repo>.git
OK, thanks for the information.
I just pushed a new commit and tagged it as v0.2.7.
This commit should fix the problem now.
BTW, the -allow-network-connection option could be used to detect the module repo URLs which are hard to guess.
Yeah I'm using that; works well.
(but does not work with the above)
(but does not work with the above)
I don't very get it. Do you mean it doesn't work with the -allow-network-connection option?
With that option it reduces the output size from 900mb to 200m but still includes the source for my private ssh cloned repo.
Some strange. What the output of with these options: golds -gen -v -source-code-reading=external -allow-network-connection -compact -s?
@alecthomas
You don't neeed to paste all the output lines. There should be two related parts in the output:
One is the line contains (working directory) guess moudle , the other is the mobule info for
your module in the working directory, like
info_module.go:679: module: k8s.io/kubernetes@3da6c11ae5fc1ee7d6f992730fc7c1dfc81ddf81 (1127 pkgs)
info_module.go:680: Pkgs[0].Dir: /home/USER/opensource/k8s.io/kubernetes/cluster/gce/gci
info_module.go:681: Dir: /home/USER/opensource/k8s.io/kubernetes
info_module.go:682: RepositoryDir: /home/USER/opensource/k8s.io/kubernetes
info_module.go:683: RepositoryURL: https://github.com/kubernetes/kubernetes
info_module.go:684: ExtraPath:
I think I get the reason, but I'm not very sure. Cloud you add the option -nouses and check whether the generated docs still includes your private source? This option should be turned off when external source links are enabled.
Ah, the last comment is not valid.
I just pushed another commit, which fixed a bug which makes the source on "bitbucket.org" unable to be linked externally.
With that option it reduces the output size from 900mb to 200m but still includes the source for my private ssh cloned repo.
Does the problem still exist with the tip? If the problem is gone, I will create the v0.2.8 tag.
I'll try to remember to check later today. No worries cutting a release though, the worst that happens is it uses a bit of extra data.