Skip to content

Commit 4e62b53

Browse files
authored
docs: change instructions for cloning the V repository to use --depth=1 (#22905)
1 parent a9ae376 commit 4e62b53

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

.github/workflows/build_vinix_locally.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ mkdir -p $BUILD
2121

2222
cd $BUILD
2323
echo "Clone current Vinix"
24-
./v retry -- git clone https://github.com/vlang/vinix.git --depth=1
24+
./v retry -- git clone --depth=1 https://github.com/vlang/vinix.git
2525

2626
cd $BUILD
2727
echo "Clone current mlibc"
28-
./v retry -- git clone https://github.com/managarm/mlibc.git --depth=1
28+
./v retry -- git clone --depth=1 https://github.com/managarm/mlibc.git
2929

3030
cd $BUILD
3131
echo "Patch mlibc for Vinix"

.github/workflows/vinix_ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
./v retry -- sudo apt install build-essential -y
3737
3838
- name: Clone current Vinix
39-
run: ./v retry -- git clone https://github.com/vlang/vinix.git
39+
run: ./v retry -- git clone --depth=1 https://github.com/vlang/vinix.git
4040

4141
- name: Download Vinix kernel dependencies
4242
run: cd vinix/kernel && ./get-deps

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ accordingly in the steps below.)
123123
Let's say that the forked repository is at
124124
`https://github.com/YOUR_GITHUB_USERNAME/v` .
125125
2. Clone the main v repository https://github.com/vlang/v to a local folder on
126-
your computer, say named nv/ (`git clone https://github.com/vlang/v nv`)
126+
your computer, say named nv/ (`git clone --depth=1 https://github.com/vlang/v nv`)
127127
3. `cd nv`
128128
3.1 (optional) Run these commands, which ensure that all your code will be
129129
automatically formatted, before committing:

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ RUN apt update && \
1414
COPY . /vlang-local
1515

1616
RUN if [ -z "${USE_LOCAL}" ] ; then \
17-
git clone https://github.com/vlang/v/ /opt/vlang && \
17+
git clone --depth=1 https://github.com/vlang/v /opt/vlang && \
1818
rm -rf /vlang-local ; \
1919
else \
2020
mv /vlang-local/* . && \

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Note: On Ubuntu/Debian, you may need to run `sudo apt install git build-essentia
8080

8181
To get started, execute the following in your terminal/shell:
8282
```bash
83-
git clone https://github.com/vlang/v
83+
git clone --depth=1 https://github.com/vlang/v
8484
cd v
8585
make
8686
```
@@ -168,7 +168,7 @@ shell/editor after that, so that it can pick up the new PATH variable.
168168
```bash
169169
# xbps-install -Su base-devel
170170
# xbps-install libatomic-devel
171-
$ git clone https://github.com/vlang/v
171+
$ git clone --depth=1 https://github.com/vlang/v
172172
$ cd v
173173
$ make
174174
```
@@ -179,7 +179,7 @@ $ make
179179

180180

181181
```bash
182-
git clone https://github.com/vlang/v
182+
git clone --depth=1 https://github.com/vlang/v
183183
cd v
184184
docker build -t vlang .
185185
docker run --rm -it vlang:latest
@@ -188,7 +188,7 @@ docker run --rm -it vlang:latest
188188
### Docker with Alpine/musl
189189

190190
```bash
191-
git clone https://github.com/vlang/v
191+
git clone --depth=1 https://github.com/vlang/v
192192
cd v
193193
docker build -t vlang_alpine - < Dockerfile.alpine
194194
alias with_alpine='docker run -u 1000:1000 --rm -it -v .:/src -w /src vlang_alpine:latest'
@@ -219,7 +219,7 @@ Linux/macos:
219219

220220
```bash
221221
pkg install clang libexecinfo libgc libgc-static make git
222-
git clone https://github.com/vlang/v
222+
git clone --depth=1 https://github.com/vlang/v
223223
cd v
224224
make
225225
```

doc/docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Anything you can do in other languages, you can do in V.
2424
The best way to get the latest and greatest V, is to install it from source.
2525
It is easy, and it takes only a few seconds:
2626
```bash
27-
git clone https://github.com/vlang/v
27+
git clone --depth=1 https://github.com/vlang/v
2828
cd v
2929
make
3030
```

0 commit comments

Comments
 (0)