Skip to content

Commit 8fa81d1

Browse files
authored
Tweak development.md for more speed (#2667)
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.
1 parent 20ab882 commit 8fa81d1

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/development.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@
55
```shell
66
git clone https://github.com/llvm/torch-mlir
77
cd torch-mlir
8-
git submodule update --init
8+
git submodule update --init --progress
99
```
1010

11+
Optionally, use `--depth=1` to make a shallow clone of the submodules.
12+
While this is running, you can already setup the Python venv and dependencies in the next step.
13+
1114
## Setup your Python VirtualEnvironment and Dependencies
1215

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

0 commit comments

Comments
 (0)