Skip to content

Commit ab7bfe5

Browse files
nickclark2016nickclark2016
authored
Merge pull request #2590 from nickclark2016/docs-cleanup-5.0-beta8
Normalize documentation, remove dead APIs and doc files
2 parents da6ba18 + d55c96a commit ab7bfe5

File tree

214 files changed

+1021
-962
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

214 files changed

+1021
-962
lines changed

‎modules/vstudio/_preload.lua‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -200,20 +200,6 @@
200200
tokens = true,
201201
}
202202

203-
p.api.register {
204-
name = "imageoptions",
205-
scope = "config",
206-
kind = "list:string",
207-
tokens = true,
208-
}
209-
210-
p.api.register {
211-
name = "imagepath",
212-
scope = "config",
213-
kind = "path",
214-
tokens = true,
215-
}
216-
217203
p.api.register {
218204
name = "inheritdependencies",
219205
scope = "config",

‎modules/vstudio/vs200x_vcproj.lua‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -775,14 +775,6 @@
775775

776776

777777

778-
function m.additionalImageOptions(cfg)
779-
if #cfg.imageoptions > 0 then
780-
p.x('AdditionalOptions="%s"', table.concat(cfg.imageoptions, " "))
781-
end
782-
end
783-
784-
785-
786778
function m.additionalIncludeDirectories(cfg)
787779
if #cfg.includedirs > 0 then
788780
local dirs = vstudio.path(cfg, cfg.includedirs)
@@ -1324,14 +1316,6 @@
13241316

13251317

13261318

1327-
function m.outputFileName(cfg)
1328-
if cfg.imagepath ~= nil then
1329-
p.x('OutputFileName="%s"', path.translate(cfg.imagepath))
1330-
end
1331-
end
1332-
1333-
1334-
13351319
function m.platforms(prj)
13361320
architectures = {}
13371321
for cfg in project.eachconfig(prj) do

‎website/docs/Feature-Matrix.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ title: Feature Matrix
55
I am filling this in as I discover missing functionality in the various exporters. So it is not (yet) a comprehensive list. Porting of Xcode and CodeLite have begun and are mostly working. CodeBlocks has not yet begun.
66

77

8-
| Feature | vcproj | vcxproj | csproj | make(C) | make(C#) | xcode |
9-
|--------------------------------|----------|----------|----------|----------|----------|----------|
10-
| buildaction() | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ |
11-
| buildlog() | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
12-
| cleanextensions() | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
13-
| Command tokens | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
14-
| Configuration maps | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ |
15-
| copylocal() | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ |
16-
| Custom Build Commands | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ |
17-
| Custom Rules | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
18-
| Extensible (call arrays) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
19-
| Makefile projects | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
20-
| Per-config file lists | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
21-
| Per-file configurations | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
22-
| Per-project configurations | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ |
23-
| New platform support | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ |
24-
| Toolset versions | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
8+
| Feature | vcproj | vcxproj | csproj | gmake(C) | gmake(C#) | xcode | Ninja |
9+
|--------------------------------|----------|----------|----------|----------|-----------|----------|----------|
10+
| buildaction() | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ |
11+
| buildlog() | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
12+
| cleanextensions() | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
13+
| Command tokens | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ |
14+
| Configuration maps | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
15+
| copylocal() | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ |
16+
| Custom Build Commands | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ |
17+
| Custom Rules | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ |
18+
| Extensible (call arrays) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
19+
| Makefile projects | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
20+
| Per-config file lists | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |
21+
| Per-file configurations | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |
22+
| Per-project configurations | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
23+
| New platform support | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ |
24+
| Toolset versions | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |

‎website/docs/Project-API.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,11 @@
8383
| [forceincludes](forceincludes.md) | |
8484
| [forceusings](forceusings.md) | |
8585
| [fpu](fpu.md) | |
86-
| [framework](framework.md) | |
8786
| [functionlevellinking](functionlevellinking.md) | |
8887
| [gccprefix](gccprefix.md) | |
8988
| [group](group.md) | |
9089
| [icon](icon.md) | |
9190
| [ignoredefaultlibraries](ignoredefaultlibraries.md) | Specify a list of default libraries to ignore |
92-
| [imageoptions](imageoptions.md) | |
93-
| [imagepath](imagepath.md) | |
9491
| [implibdir](implibdir.md) | |
9592
| [implibextension](implibextension.md) | |
9693
| [implibname](implibname.md) | |

‎website/docs/allmodulespublic.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1-
allmodulespublic
1+
Specifies if all modules in the C++ projects are public.
22

33
```lua
4-
allmodulespublic "value"
4+
allmodulespublic ("value")
55
```
66

77
### Parameters ###
88

9-
`value` one of:
10-
* `On` - All C++ modules in the given project(s) will be public.
11-
* `Off` - Not all C++ modules in the given project(s) will be public.
9+
`value` is one of:
10+
11+
| Value | Description |
12+
|-------|-------------|
13+
| On | All C++ modules in the given project(s) will be public. |
14+
| Off | Not all C++ modules in the given project(s) will be public. |
1215

1316
## Applies To ###
1417

15-
The `config` scope.
18+
Project configurations.
1619

1720
### Availability ###
1821

19-
Visual Studio 2019 and later.
20-
Premake 5.0-beta2 or later.
22+
Premake 5.0.0-beta2 and later for Visual Studio 2019 and later.
2123

2224
### Examples ###
2325

‎website/docs/allowcopylocal.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Specifies whether or not to allow for copy local of assemblies.
22

33
```lua
4-
allowcopylocal "value"
4+
allowcopylocal ("value")
55
```
66

77
### Parameters ###
@@ -20,7 +20,7 @@ Project configurations.
2020

2121
### Availability ###
2222

23-
Premake 5.0-beta8 or later for Visual Studio C# Projects.
23+
Premake 5.0.0-beta8 or later for Visual Studio C# Projects.
2424

2525
### See Also ###
2626

‎website/docs/androidapilevel.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ androidapilevel (value)
1010

1111
## Applies To ###
1212

13-
The `config` scope.
13+
Project configurations.
1414

1515
### Availability ###
1616

17-
Premake 5.0.0 alpha 14 or later.
17+
Premake 5.0.0-alpha14 or later.
1818

1919
### Examples ###
2020

‎website/docs/androidapplibname.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ By default, the project name will be used as the file name for the APK.
1212

1313
## Applies To ###
1414

15-
The `config` scope.
15+
Project configurations.
1616

1717
### Availability ###
1818

19-
Premake 5.0.0 alpha 14 or later.
19+
Premake 5.0.0-alpha14 or later.
2020

2121
### Examples ###
2222

‎website/docs/architecture.md‎

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,43 @@ architecture ("value")
88

99
`value` is one of:
1010

11-
* `universal`: The universal binaries supported by iOS and macOS
12-
* `x86`
13-
* `x86_64`
14-
* `ARM`
15-
* `ARM64`
16-
* `RISCV64`
17-
* `loongarch64`
18-
* `ppc`
19-
* `ppc64`
20-
* `wasm32`,
21-
* `wasm64`,
22-
* `e2k`,
23-
* `mips64el`,
24-
* `armv5`: Only supported in VSAndroid projects
25-
* `armv7`: Only supported in VSAndroid projects
26-
* `aarch64`: Only supported in VSAndroid projects
27-
* `mips`: Only supported in VSAndroid projects
28-
* `mips64`: Only supported in VSAndroid projects
11+
| Value | Description | Notes |
12+
|-------------|-------------|-------|
13+
| universal | Universal binaries supported by iOS and macOS |
14+
| x86 | x86 Architecture |
15+
| x86_64 | x86_64 Architecture |
16+
| ARM | 32-bit ARM Architecture |
17+
| ARM64 | 64-bit ARM Architecture |
18+
| RISCV64 | 64-bit RISCV Architecture |
19+
| loongarch64 | 64-bit LoongArch Architecture |
20+
| ppc | 32-bit PowerPC Architecture |
21+
| ppc64 | 64-bit PowerPC Architecture |
22+
| wasm32 | 32-bit WASM Architecture |
23+
| wasm64 | 64-bit WASM Architecture |
24+
| e2k | Elbrus-2000 Architecture |
25+
| mips64el | 64-bit MIPS (Little Endian) Architecture |
26+
| armv5 | ARMv5 Architecture | Only supported in VSAndroid projects |
27+
| armv7 | ARMv7 Architecture | Only supported in VSAndroid projects |
28+
| aarch64 | 64-bit ARM Architecture | Only supported in VSAndroid projects |
29+
| mips | 32-bit MIPS Architecture | Only supported in VSAndroid projects |
30+
| mips64 | 64-bit MIPS Architecture | Only supported in VSAndroid projects |
2931

3032
Additional values that are aliases for the above:
3133

32-
* `i386`: Alias for `x86`
33-
* `amd64`: Alias for `x86_64`
34-
* `x32`: Alias for `x86`; There is intent to deprecate this
35-
* `x64`: Alias for `x86_64`; There is intent to deprecate this
34+
| Value | Description |
35+
|-------|-------------|
36+
| i386 | Alias for `x86` |
37+
| amd64 | Alias for `x86_64` |
38+
| x32 | Alias for `x86`. There is intent to deprecate this |
39+
| x64 | Alias for `x86_64`. There is intent to deprecate this |
3640

3741
### Applies To ###
3842

3943
Project configurations.
4044

4145
### Availability ###
4246

43-
Premake 5.0 or later.
47+
Premake 5.0.0-alpha1 or later.
4448

4549
### Examples ###
4650

‎website/docs/assemblydebug.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
1-
assemblydebug - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
1+
Specifies if assembly debug features should be turned on.
22

33
```lua
4-
assemblydebug (value)
4+
assemblydebug ("value")
55
```
66

77
### Parameters ###
88

9-
`value` - needs documentation.
9+
`value` is one of:
10+
11+
| Value | Description |
12+
|-------|-------------|
13+
| On | Assembly debug features are turned on |
14+
| Off | Assembly debug features are turned off |
1015

1116
## Applies To ###
1217

13-
The `config` scope.
18+
Project configurations.
1419

1520
### Availability ###
1621

17-
Premake 5.0.0 alpha 16 or later.
22+
Premake 5.0.0-alpha16 or later for Visual Studio projects.
1823

1924
### Examples ###
2025

2126
```lua
22-
assemblydebug (value)
27+
assemblydebug ("On")
2328
```
2429

0 commit comments

Comments
 (0)