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

wiki: document gomote for first time users #31118

Closed
eliasnaur opened this issue Mar 28, 2019 · 1 comment
Closed

wiki: document gomote for first time users #31118

eliasnaur opened this issue Mar 28, 2019 · 1 comment
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@eliasnaur
Copy link
Contributor

Thanks for this. If there's one thing that could make the wiki significantly clearer it would be a paragraph about directory structure and the "gomote machine model". It took me a bunch of try-and-error runs to find out. Much of it may be "obvious" in retrospect, but it helps spelling it out right away, especially for first-time gomote users. This would provide newcomers a clearer model of how the gomote looks like from a client's perspective.

Some of the things that would be nice if they were spelled out:

  • each instance of a gomote has its own working directory, accessible via $WORKDIR
  • gomote push does essentially an rsync of the $GOROOT directory into the remote $WORKDIR; i.e., after a gomote push, the local $GOROOT appears as go directory on the gomote (I had to find this out by doing repeated gomote ls commands)
  • when issuing gomote run commands, one needs to specify the full path for commands and files, e.g. go/bin/go tool compile go/src/mypkg/x.go - there appears no notion of a cwd, or perhaps I missed it
  • to change individual uploaded files, make the changes locally and use gomote push $MOTE and it will only upload the changes (this was not obvious to me at first, especially because there's also a gomote put command to push single files. I thought I was supposed to use that one for smaller changes)
  • I didn't figure out to how to use gomote put to get a file into a specific directory on the gomote instance (I still don't know how to do it, but I resorted to just using gomote push all the time.)
  • explain that the gomote self-destructs after 30min of non-use
  • I'm unclear on the -system flag

Originally posted by @griesemer in #31091 (comment)

@bradfitz bradfitz added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Mar 28, 2019
@bradfitz bradfitz added this to the Unreleased milestone Mar 28, 2019
@mknyszek
Copy link
Contributor

I updated the wiki and I think I hit your main points: https://github.com/golang/go/wiki/Gomote.

Closing for now. Feel free to reopen.

@golang golang locked and limited conversation to collaborators Nov 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

4 participants