Skip to content

Commit

Permalink
docs: change instructions for cloning the V repository to use `--dept…
Browse files Browse the repository at this point in the history
…h=1` (#22905)
  • Loading branch information
spytheman authored Nov 18, 2024
1 parent a9ae376 commit 4e62b53
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build_vinix_locally.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ mkdir -p $BUILD

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

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

cd $BUILD
echo "Patch mlibc for Vinix"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/vinix_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
./v retry -- sudo apt install build-essential -y
- name: Clone current Vinix
run: ./v retry -- git clone https://github.com/vlang/vinix.git
run: ./v retry -- git clone --depth=1 https://github.com/vlang/vinix.git

- name: Download Vinix kernel dependencies
run: cd vinix/kernel && ./get-deps
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ accordingly in the steps below.)
Let's say that the forked repository is at
`https://github.com/YOUR_GITHUB_USERNAME/v` .
2. Clone the main v repository https://github.com/vlang/v to a local folder on
your computer, say named nv/ (`git clone https://github.com/vlang/v nv`)
your computer, say named nv/ (`git clone --depth=1 https://github.com/vlang/v nv`)
3. `cd nv`
3.1 (optional) Run these commands, which ensure that all your code will be
automatically formatted, before committing:
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ RUN apt update && \
COPY . /vlang-local

RUN if [ -z "${USE_LOCAL}" ] ; then \
git clone https://github.com/vlang/v/ /opt/vlang && \
git clone --depth=1 https://github.com/vlang/v /opt/vlang && \
rm -rf /vlang-local ; \
else \
mv /vlang-local/* . && \
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Note: On Ubuntu/Debian, you may need to run `sudo apt install git build-essentia

To get started, execute the following in your terminal/shell:
```bash
git clone https://github.com/vlang/v
git clone --depth=1 https://github.com/vlang/v
cd v
make
```
Expand Down Expand Up @@ -168,7 +168,7 @@ shell/editor after that, so that it can pick up the new PATH variable.
```bash
# xbps-install -Su base-devel
# xbps-install libatomic-devel
$ git clone https://github.com/vlang/v
$ git clone --depth=1 https://github.com/vlang/v
$ cd v
$ make
```
Expand All @@ -179,7 +179,7 @@ $ make


```bash
git clone https://github.com/vlang/v
git clone --depth=1 https://github.com/vlang/v
cd v
docker build -t vlang .
docker run --rm -it vlang:latest
Expand All @@ -188,7 +188,7 @@ docker run --rm -it vlang:latest
### Docker with Alpine/musl

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

```bash
pkg install clang libexecinfo libgc libgc-static make git
git clone https://github.com/vlang/v
git clone --depth=1 https://github.com/vlang/v
cd v
make
```
Expand Down
2 changes: 1 addition & 1 deletion doc/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Anything you can do in other languages, you can do in V.
The best way to get the latest and greatest V, is to install it from source.
It is easy, and it takes only a few seconds:
```bash
git clone https://github.com/vlang/v
git clone --depth=1 https://github.com/vlang/v
cd v
make
```
Expand Down

0 comments on commit 4e62b53

Please sign in to comment.