Skip to content

Commit

Permalink
docs: Reformat sbt settings table to Markdown (#3801)
Browse files Browse the repository at this point in the history
  • Loading branch information
@JD557
JD557 committed Mar 3, 2024
1 parent 9545efb commit 7ecd3a2
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/user/sbt.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,25 +119,25 @@ nativeConfig ~= { c =>
*/
```

Since Name Type Description
------- ------------------------ ---------------- ------------------------------------------------------------------------------
0.1 `compile` `Analysis` Compile Scala code to NIR
0.1 `run` `Unit` Compile, link and run the generated binary
0.1 `package` `File` Similar to standard package with addition of NIR
0.1 `publish` `Unit` Similar to standard publish with addition of NIR (1)
0.1 `nativeLink` `File` Link NIR and generate native binary
0.1 `nativeClang` `File` Path to `clang` command
0.1 `nativeClangPP` `File` Path to `clang++` command
0.1 `nativeCompileOptions` `Seq[String]` Extra options passed to clang verbatim during compilation
0.1 `nativeLinkingOptions` `Seq[String]` Extra options passed to clang verbatim during linking
0.1 `nativeMode` `String` One of `"debug"`, `"release-fast"`, `"release-size"` or `"release-full"` (2)
0.2 `nativeGC` `String` One of `"none"`, `"boehm"`, `"immix"` or `"commix"` (3)
0.3.3 `nativeLinkStubs` `Boolean` Whether to link `@stub` definitions, or to ignore them
0.4.0 `nativeConfig` `NativeConfig` Configuration of the Scala Native plugin
0.4.0 `nativeLTO` `String` One of `"none"`, `"full"` or `"thin"` (4)
0.4.0 `targetTriple` `String` The platform LLVM target triple
0.4.0 `nativeCheck` `Boolean` Shall the linker check intermediate results for correctness?
0.4.0 `nativeDump` `Boolean` Shall the linker dump intermediate results to disk?
| Since | Name | Type | Description |
|--------|-------------------------|-----------------|-------------------------------------------------------------------------------|
| 0.1 | `compile` | `Analysis` | Compile Scala code to NIR |
| 0.1 | `run` | `Unit` | Compile, link and run the generated binary |
| 0.1 | `package` | `File` | Similar to standard package with addition of NIR |
| 0.1 | `publish` | `Unit` | Similar to standard publish with addition of NIR (1) |
| 0.1 | `nativeLink` | `File` | Link NIR and generate native binary |
| 0.1 | `nativeClang` | `File` | Path to `clang` command |
| 0.1 | `nativeClangPP` | `File` | Path to `clang++` command |
| 0.1 | `nativeCompileOptions` | `Seq[String]` | Extra options passed to clang verbatim during compilation |
| 0.1 | `nativeLinkingOptions` | `Seq[String]` | Extra options passed to clang verbatim during linking |
| 0.1 | `nativeMode` | `String` | One of `"debug"`, `"release-fast"`, `"release-size"` or `"release-full"` (2) |
| 0.2 | `nativeGC` | `String` | One of `"none"`, `"boehm"`, `"immix"` or `"commix"` (3) |
| 0.3.3 | `nativeLinkStubs` | `Boolean` | Whether to link `@stub` definitions, or to ignore them |
| 0.4.0 | `nativeConfig` | `NativeConfig` | Configuration of the Scala Native plugin |
| 0.4.0 | `nativeLTO` | `String` | One of `"none"`, `"full"` or `"thin"` (4) |
| 0.4.0 | `targetTriple` | `String` | The platform LLVM target triple |
| 0.4.0 | `nativeCheck` | `Boolean` | Shall the linker check intermediate results for correctness? |
| 0.4.0 | `nativeDump` | `Boolean` | Shall the linker dump intermediate results to disk? |

1. See [Publishing](#publishing) and [Cross
compilation](#cross-compilation) for details.
Expand Down

0 comments on commit 7ecd3a2

Please sign in to comment.