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

utils/update_tools/update_tools.py needs documentation #1785

Open
HackerFoo opened this issue Nov 18, 2020 · 3 comments
Open

utils/update_tools/update_tools.py needs documentation #1785

HackerFoo opened this issue Nov 18, 2020 · 3 comments

Comments

@HackerFoo
Copy link
Contributor

It would be much easier to remember how to use this script (for infrequent users) if there was documentation on how to use it. Something like:

  1. Create a fresh checkout:
  cd <somewhere>
  git clone <repo>
  1. Update master in that repo:
  git checkout master
  git reset --hard <upstream url>/master
  1. Run the script:
  ./utils/update_tools/update_tools.py --location <somewhere>/<repo> --branch_name master+wip-next
  1. Push to your fork, then make a PR
@litghost
Copy link
Contributor

Steps 1 and 2 are not required, you can just point it at a new folder and it does steps 1 and 2 for you. Your point on documentation is valid.

@HackerFoo
Copy link
Contributor Author

HackerFoo commented Nov 18, 2020

Step 1 might not be needed, but step 2 is, or at least rebasing/resetting master from upstream. Step 1 is less error prone/simpler than "clean up your working repo and fetch/update all branches." It's also not clear if changes in local wip/* branches will have any effect.

@litghost
Copy link
Contributor

litghost commented Nov 18, 2020

Step 2 should be handled by "pull-bot", e.g. SymbiFlow/vtr-verilog-to-routing#556 The yosys version of pull-bot merges automatically, but the one on SymbiFlow/vtr doesn't. Regardless, step 2 should be handled in a "public" fashion, rather than a local one.

You can operate update_tools.py on a fork, in which case step 2 should still be reflected on the remote, rather than just locally.

Step 1 (e.g. clean repo) is the behavior or update_tools.py in a clean directory. I'm wary of having update_tools.py doing the cleaning/rm -rf, but we could modify it to complain if the directory already has a git repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants