Skip to content

Commit 3ce637b

Browse files
soypatdeadprogram
authored andcommitted
apply @aykevl's suggestions
1 parent d5288b8 commit 3ce637b

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

content/docs/guides/build/additional-requirements.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ description: >
77

88
We're not done yet. Some extra things need to be built before you can start using TinyGo.
99

10-
If you haven't already, you need to download llvm-project (for the compiler-rt sources that are needed for most architectures):
10+
If you haven't already, you need to download llvm-project (for the compiler-rt sources that are needed for most architectures).
11+
Run the following commands inside your cloned TinyGo repository:
1112

1213
```shell
1314
make llvm-source
@@ -28,7 +29,7 @@ make binaryen
2829

2930
These command may need to be re-run after some updates in TinyGo.
3031

31-
There are also some extra tools you will need to install, depending on your operating system. These tools are gcc-avr, avr-libc, avrdude, and openocd. Check the additional requirements for your operating system:
32+
There are also some extra tools you will need to install, depending on your operating system. These tools are avrdude and openocd. Check the additional requirements for your operating system:
3233

3334
* [Linux](/getting-started/install/linux/)
3435
* [MacOS](/getting-started/install/macos/)

content/docs/guides/build/bring-your-own-llvm.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ For **Debian** or **Ubuntu** you can install LLVM by adding a new apt repository
3838
| Debian | sid | `unstable`|
3939

4040
```shell
41-
echo 'deb http://apt.llvm.org/xxxxx/ llvm-toolchain-xxxxx-16 main' | sudo tee /etc/apt/sources.list.d/llvm.list
41+
echo 'deb http://apt.llvm.org/xxxxx/ llvm-toolchain-xxxxx-17 main' | sudo tee /etc/apt/sources.list.d/llvm.list
4242
```
4343

4444
After adding the apt repository for your distribution you may install the LLVM toolchain packages:
4545

4646
```shell
4747
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
4848
sudo apt-get update
49-
sudo apt-get install clang-16 llvm-16-dev lld-16 libclang-16-dev
49+
sudo apt-get install clang-17 llvm-17-dev lld-17 libclang-17-dev
5050
```
5151

5252
#### MacOS
@@ -100,8 +100,7 @@ The `go install` command will build the `tinygo` executable and store it to your
100100
```
101101
102102
### Debian LLVM repository manual addition
103-
If `sudo apt-get install clang-16 llvm-16-dev lld-16 libclang-16-dev` does not work you
104-
can try manually adding the repository. Run the following command and try the steps above again.
103+
If `sudo apt-get install clang-xx llvm-xx-dev lld-xx libclang-xx-dev` does not work, where `xx` is the LLVM version required by the TinyGo branch you are building i.e: 17, please try manually adding the repository. Run the following command and try the steps above again.
105104
```shell
106105
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
107106
```

content/docs/guides/build/manual-llvm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export PATH="$PATH:/c/Program Files/CMake/bin"
5757
## Building LLVM
5858
***The following instructions are common to all operating systems.***
5959

60-
Background: *[LLVM](https://llvm.org/) is used by TinyGo to create smaller programs than can be compiled with normal Go distribution. It is commonly referred to as a *compiler infrastructure* since it provides several tools to build, link and optimize programs which adhere to its framework.*
60+
Background: *[LLVM](https://llvm.org/) is a library and collection of tools for building compilers. It is the base of many newer compilers, like Clang, Swift, and the Rust compiler so they can all build on the same high-quality base. Similarly, TinyGo uses LLVM for all its low-level optimization and machine code generation so that it can produce code that's roughly as small and efficient as all these other modern compilers.*
6161

6262
We build LLVM from inside the TinyGo repository we cloned in the [previous step](../). The following command when run inside the TinyGo repo will take care of first downloading the LLVM source code to later build it in the next step. It places the source code in `llvm-project/` and the build output in `llvm-build/`. It only needs to be done once until the next LLVM release (every half year).
6363

0 commit comments

Comments
 (0)