Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions website/docs/allmodulespublic.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
allmodulespublic
---
title: allmodulespublic
description: "Controls whether all C++ modules in the project are exported as public modules."
keywords: [premake,visual studio,modules,public]
---

Controls whether all C++ modules in the project are exported as public modules.

```lua
allmodulespublic "value"
```

### Parameters ###

`value` one of:
* `On` - All C++ modules in the given project(s) will be public.
* `Off` - Not all C++ modules in the given project(s) will be public.
| value | Description |
| ----- | ------------------------------------------------------------- |
| On | All C++ modules in the given project(s) will be public. |
| Off | Not all C++ modules in the given project(s) will be public.[] |

## Applies To ###

Expand Down
10 changes: 8 additions & 2 deletions website/docs/androidapilevel.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
---
title: androidapilevel
keywords: [premake, android, api, level, config]
description: Specifies the target Android API level.
---

Specifies the target Android API level.

```lua
androidapilevel (value)
androidapilevel(level)
```

### Parameters ###

`value` is a number specifying the target Android API level.
`level` **number** - is a number specifying the target Android API level.

## Applies To ###

Expand Down
10 changes: 8 additions & 2 deletions website/docs/androidapplibname.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
---
title: androidapplibname
description: Specfies the file name for the output APK.
keywords: [premake, android, apk, filename, config]
---

Specfies the file name for the output APK.

```lua
androidapplibname ("value")
androidapplibname ("filename")
```

By default, the project name will be used as the file name for the APK.

### Parameters ###

`value` is the new file name.
`filename` **string** - is the new file name.

## Applies To ###

Expand Down
59 changes: 34 additions & 25 deletions website/docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,47 @@
---
title: architecture
description: Specifies the system architecture to be targeted by the configuration.
keywords: [premake, architecture, system, config, x86, x86_64, arm, arm64, riscv64, wasm]
---

Specifies the system architecture to be targeted by the configuration.

```lua
architecture ("value")
architecture ("arch")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both "value"/"arch" are wrong there (not valid value). value/arch would be good (variable might have a correct value)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the idea is to be able to extract the name and get the following:

function architecture(arch) end

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the quotes that bore me (which shouldn't avoid the name extraction).

Some APIs accept mostly any strings, some quote are OKish, some expect specific string, and providing unexpected ones is confusing IMO.
architecture ("value") was already wrong, and should have been architecture (value) (or architecture ("%{value}")).
And then you should only have renamed 'value' to 'arch'.

```

### Parameters ###

`value` is one of:

* `universal`: The universal binaries supported by iOS and macOS
* `x86`
* `x86_64`
* `ARM`
* `ARM64`
* `RISCV64`
* `loongarch64`
* `ppc`
* `ppc64`
* `wasm32`,
* `wasm64`,
* `e2k`,
* `mips64el`,
* `armv5`: Only supported in VSAndroid projects
* `armv7`: Only supported in VSAndroid projects
* `aarch64`: Only supported in VSAndroid projects
* `mips`: Only supported in VSAndroid projects
* `mips64`: Only supported in VSAndroid projects
| Arch | Description |
|-------------|--------------------------------------------------|
| universal | Universal binaries supported by iOS and macOS |
| x86 | 32-bit x86 architecture |
| x86_64 | 64-bit x86 architecture |
| ARM | 32-bit ARM architecture |
| ARM64 | 64-bit ARM architecture |
| RISCV64 | 64-bit RISC-V architecture |
| loongarch64 | 64-bit LoongArch architecture |
| ppc | 32-bit PowerPC architecture |
| ppc64 | 64-bit PowerPC architecture |
| wasm32 | 32-bit WebAssembly target |
| wasm64 | 64-bit WebAssembly target |
| e2k | Elbrus 2000 architecture |
| mips64el | 64-bit MIPS little-endian architecture |
| armv5 | ARMv5 (only supported in VSAndroid projects) |
| armv7 | ARMv7 (only supported in VSAndroid projects) |
| aarch64 | AArch64 (only supported in VSAndroid projects) |
| mips | MIPS (only supported in VSAndroid projects) |
| mips64 | 64-bit MIPS (only supported in VSAndroid projects) |

Additional values that are aliases for the above:

* `i386`: Alias for `x86`
* `amd64`: Alias for `x86_64`
* `x32`: Alias for `x86`; There is intent to deprecate this
* `x64`: Alias for `x86_64`; There is intent to deprecate this
| arch | Description |
|-------|-----------------------------------------------|
| i386 | Alias for `x86` |
| amd64 | Alias for `x86_64` |
| x32 | Alias for `x86`; there is intent to deprecate |
| x64 | Alias for `x86_64`; there is intent to deprecate |


### Applies To ###

Expand Down
14 changes: 10 additions & 4 deletions website/docs/assemblydebug.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
assemblydebug - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
---
title: assemblydebug
description: Generates assembly-level debug information in Visual Studio projects
keywords: [premake, assemblydebug, visual studio, debug, config]
---

Generates assembly-level debug information in Visual Studio projects

```lua
assemblydebug (value)
assemblydebug(enable)
```

### Parameters ###

`value` - needs documentation.
`enable` **boolean** - enable/disable assemblydebug.

## Applies To ###

Expand All @@ -19,6 +25,6 @@ Premake 5.0.0 alpha 16 or later.
### Examples ###

```lua
assemblydebug (value)
assemblydebug(true)
```

6 changes: 6 additions & 0 deletions website/docs/atl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: atl
description: Enables Microsoft's Active Template Library in a project.
keywords: [premake, atl, active template library, visual studio, project, config]
---

Enables Microsoft's Active Template Library in a project.

```lua
Expand Down
10 changes: 8 additions & 2 deletions website/docs/basedir.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
---
title: basedir
description: Sets the base directory for a configuration
keywords: [premake, basedir, base directory, path, configuration]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems you use config in other places

---

Sets the base directory for a configuration, from with other paths contained by the configuration will be made relative at export time.

```lua
basedir ("value")
basedir ("path")
```

You do not normally need to set this value, as it is filled in automatically with the current working directory at the time the configuration block is created by the script.

### Parameters ###

`value` is an absolute path, from which other paths contained by the configuration should be made relative.
`path` **string** - is an absolute path, from which other paths contained by the configuration should be made relative.

### Applies To ###

Expand Down
8 changes: 7 additions & 1 deletion website/docs/bindirs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: bindirs
description: Specifies extra paths to use when executing build commands
keywords: [premake, bindirs, build commands, executable paths, config]
---

Specifies extra paths to use when executing build commands

```lua
Expand All @@ -6,7 +12,7 @@ bindirs { "directories" }

### Parameters ###

`directories` - paths containing executable to run when building command.
`directories` **string[]** - paths containing executable to run when building command.

### Applies To ###

Expand Down
11 changes: 10 additions & 1 deletion website/docs/buildaction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: buildaction
description: Specifies how a file or set of files should be treated during the compilation process
keywords: [premake, buildaction, msbuild, visual studio, compile, embed, copy, resource, config]
---

Specifies how a file or set of files should be treated during the compilation process. It is usually paired with a filter to select a file set. If no build action is specified for a file a default action will be used, based on the file's extension.

```lua
Expand All @@ -23,8 +29,10 @@ For C/C++, `action` is the name of the MSBuild action as defined by the vcxproj
| AppxManifest | Treat the file as AppX Manifest; required for UWP applications. |
| Copy | Copy the file to the target directory. |

:::warning
For C# projects, `buildaction` behaviour is special to support legacy implementation.
In C#, `action` is one of
:::

| Action | Description |
|-------------|-----------------------------------------------------------------------|
Expand All @@ -38,8 +46,9 @@ In C#, `action` is one of
| Resource | Copy/embed the file with the project resources. |
| UserControl | Treat the source file as [visual user control][2]. |

:::warning
The descriptive actions such as **Component**, **Form*, and **UserControl** are only recognized by Visual Studio, and may be considered optional as Visual Studio will automatically deduce the types when it first examines the project. You only need to specify these actions to avoid unnecessary modifications to the project files on save.

:::
### Applies To ###

File configurations.
Expand Down
8 changes: 7 additions & 1 deletion website/docs/buildcommands.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: buildcommands
description: Specifies one or more shell commands to be executed to build a project or file
keywords: [premake, buildcommands, shell, makefile, custom, config]
---

Specifies one or more shell commands to be executed to build a project or file.

```lua
Expand All @@ -6,7 +12,7 @@ buildcommands { "commands" }

### Parameters ###

`commands` specifies a list of one or more shell commands to be executed. The commands may use [tokens](Tokens.md).
`commands` **string[]** - specifies a list of one or more shell commands to be executed. The commands may use [tokens](Tokens.md).

### Applies To ###

Expand Down
10 changes: 8 additions & 2 deletions website/docs/buildcustomizations.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
---
title: buildcustomizations
description: Imports custom .props files for Visual Studio.
keywords: [premake, buildcustomizations, visual studio, props, project]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'project' versus 'project config'?

---

Imports custom .props files for Visual Studio.

```lua
buildcustomizations { "string" }
buildcustomizations { "name" }
```

### Parameters ###

`value` - needs documentation.
`name` **string** — The name of the Visual Studio build customization to import (corresponding to a `.props` file, without extension)..

### Applies To ###

Expand Down
8 changes: 7 additions & 1 deletion website/docs/builddependencies.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: builddependencies
description: Specifies any additional dependencies for the target of a custom build rule.
keywords: [premake, builddependencies, dependencies]
---

Specifies any additional dependencies for the target of a custom build rule.

```lua
Expand All @@ -6,7 +12,7 @@ builddependencies { "files" }

### Parameters ###

`files` specifies a list of file path for additional dependencies.
`files` **string[]** - specifies a list of file paths for additional dependencies.


### Applies To ###
Expand Down
8 changes: 7 additions & 1 deletion website/docs/buildinputs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: buildinputs
description: Specifies the source file file inputs of a custom build command or rule.
keywords: [premake, buildinputs, custom build, inputs, source files, project config]
---

Specifies the source file file inputs of a custom build command or rule.

```lua
Expand All @@ -6,7 +12,7 @@ buildinputs { "inputs" }

### Parameters ###

`inputs` is the list of input source files.
`inputs` **string** - is the list of input source files.


### Applies To ###
Expand Down
10 changes: 8 additions & 2 deletions website/docs/buildlog.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
---
title: buildlog
description: Specifies the output location of a toolset's build logs.
keywords: [premake, buildlog, build logs, visual studio, project config, path]
---

Specifies the output location of a toolset's build logs.

```lua
buildlog ("path")
buildlog("path")
```

If a build log path has not been specified, the toolset's default path will be used.

### Parameters ###

`path` is the output file system location for the build log file.
`path` **string** - is the output file system location for the build log file.

### Applies To ###

Expand Down
8 changes: 7 additions & 1 deletion website/docs/buildmessage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: buildmessage
description: Specifies the text to output to the when a custom build command or rule is executed.
keywords: [premake, buildmessage, custom build, message, output, project config, rules]
---

Specifies the text to output to the when a custom build command or rule is executed.

```lua
Expand All @@ -6,7 +12,7 @@ buildmessage ("message")

### Parameters ###

`message` is the text to write to standard output.
`message` **string** - is the text to write to standard output.


### Applies To ###
Expand Down
Loading
Loading