@yowasp/clang 0.0.0 → 21.1.4-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,19 +3,25 @@ YoWASP Clang/LLD package
3
3
 
4
4
  This package provides a complete [Clang/LLD][] toolchain built for [WebAssembly][] and targeting WebAssembly as well. See the [overview of the YoWASP project][yowasp] for details.
5
5
 
6
- At the moment, this package only provides an API allowing to run Clang and LLD in a virtual filesystem; no binaries are provided.
6
+ At the moment, this package only offers an API allowing to run Clang and LLD in a virtual filesystem; no executables are provided.
7
7
 
8
- [llvm/clang]: https://llvm.org/
9
- [webassembly]: https://webassembly.org/
8
+ [Clang/LLD]: https://llvm.org/
9
+ [WebAssembly]: https://webassembly.org/
10
10
  [yowasp]: https://yowasp.github.io/
11
11
 
12
12
 
13
13
  API reference
14
14
  -------------
15
15
 
16
- This package provides one function:
16
+ This package provides two functions:
17
17
 
18
18
  - `runLLVM`
19
+ - The first argument is the utility to run: one of `addr2line`, `ar`, `c++filt`, `dwarfdump`, `nm`, `objcopy`, `objdump`, `readobj`, `ranlib`, `size`, `strip`, `symbolizer`, `wasm-ld`.
20
+ - `runClang`
21
+ - The first argument is either `clang` or `clang++`.
22
+ - Due to WASI limitations (an inability to spawn subprocesses), this function is a wrapper that parses the output of `clang -###` or `clang++ -###` to determine the sequence of processes to run. The parser was written with great care and handles many common exceptional conditions (e.g. the `-help` option), but the resulting function still deviates from how a standard Clang compiler driver would behave. Please report any deviations that impact your workflow as [issues].
23
+
24
+ [issues]: https://github.com/YoWASP/clang/issues
19
25
 
20
26
  For more detail, see the documentation for [the JavaScript YoWASP runtime](https://github.com/YoWASP/runtime-js#api-reference).
21
27
 
@@ -39,4 +45,4 @@ With this scheme, there is a direct correspondence between upstream versions and
39
45
  License
40
46
  -------
41
47
 
42
- This package is covered by the [MIT license](LICENSE.txt), which is the same as the [Boolector license](https://github.com/Boolector/boolector/blob/master/COPYING).
48
+ This package is covered by the [Apache 2 license](LICENSE.txt), which is the same as the (base) [LLVM license](https://github.com/llvm/llvm-project/blob/main/LICENSE.TXT).