Skip to content

Commit

Permalink
Tweak development.md for more speed (#2667)
Browse files Browse the repository at this point in the history
Adding the `--progress` flag shows the same output as what `git clone`
would show. This is very nice for slow connections. Without it, the
command may run for many minutes without providing any indication that
it is still doing something.

For `--depth=1`, I think it should be safe as most people have new
enough git versions nowadays, but let's be safe and make it an optional
suggestion. I ran all the tests fine with `--depth=1`, but I don't know
whether things will keep working when the submodules get updated for
systems with old git versions.
  • Loading branch information
rikhuijzer authored Dec 20, 2023
1 parent 20ab882 commit 8fa81d1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@
```shell
git clone https://github.com/llvm/torch-mlir
cd torch-mlir
git submodule update --init
git submodule update --init --progress
```

Optionally, use `--depth=1` to make a shallow clone of the submodules.
While this is running, you can already setup the Python venv and dependencies in the next step.

## Setup your Python VirtualEnvironment and Dependencies

Also, ensure that you have the appropriate `python-dev` package installed
Expand Down

0 comments on commit 8fa81d1

Please sign in to comment.