Skip to content

Commit 0e70ae7

Browse files
samsinsanesamsinsane
committed
Added check for missing values in documentation to docs-check action
- Added missing values in documentation files
1 parent 12bc2ea commit 0e70ae7

15 files changed

+89
-6
lines changed

‎scripts/docscheck.lua‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,20 @@
66
for k,v in pairs(premake.field._loweredList) do
77
local docfilepath = "../website/docs/" .. k .. ".md"
88
local exists = os.isfile(docfilepath)
9-
if not exists then
9+
if exists then
10+
local docfile = io.open(docfilepath, "r")
11+
local text = docfile:read("*all")
12+
docfile:close()
13+
-- Verify that every value is listed
14+
if type(v.allowed) == "table" then
15+
for _,value in ipairs(v.allowed) do
16+
if type(value) == "string" and not string.find(text, value, 1, true) then
17+
count = count + 1
18+
print(k .. " missing value `" .. value .. "`")
19+
end
20+
end
21+
end
22+
else
1023
print("Missing documentation file for: ", k)
1124
count = count + 1
1225
end

‎website/docs/architecture.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ architecture ("value")
1313
* `x86_64`
1414
* `ARM`
1515
* `ARM64`
16+
* `armv5`: Only supported in VSAndroid projects
17+
* `armv7`: Only supported in VSAndroid projects
18+
* `aarch64`: Only supported in VSAndroid projects
19+
* `mips`: Only supported in VSAndroid projects
20+
* `mips64`: Only supported in VSAndroid projects
1621

1722
Additional values that are aliases for the above:
1823

‎website/docs/clr.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ See [/clr (Common Language Runtime Compilation)](http://msdn.microsoft.com/en-us
1717
| Pure | Enable pure mode MSIL. Equivalent to "On" for .NET projects. |
1818
| Safe | Enable verifiable MSIL. Equivalent to "On" for .NET projects. |
1919
| Unsafe | Enable unsafe operations. Equivalent to "On" for Managed C++ projects. |
20+
| NetCore | Needs documentation |
2021

2122
CLR settings that do not make sense for the current configuration, such setting CLR support for a C# project to "Off", will be ignored.
2223

‎website/docs/debugformat.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ debugformat "format"
1010

1111
| Value | Description |
1212
|-------------|---------------------------------------------------------------------------------------------|
13+
| Default | Specifies default debug format should be used by toolset. |
1314
| c7 | Specifies that MSVC should store debuginfo in the objects rather than a separate .pdb file. |
15+
| Dwarf | Needs documentation |
16+
| SplitDwarf | Needs documetation |
1417

1518
**Note for Visual Studio Users:** Use [editandcontinue](editandcontinue.md) to control the `/Zi` and `/ZI` switches; see [this discussion](https://github.com/premake/premake-core/issues/1425) for more information.
1619

‎website/docs/debugger.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ debugger "value"
1010
* `Default` - needs documentation.
1111
* `GDB` - needs documentation.
1212
* `LLDB` - needs documentation.
13+
* `VisualStudioLocal` - needs documentation.
14+
* `VisualStudioRemote` - needs documentation.
15+
* `VisualStudioWebBrowser` - needs documentation.
16+
* `VisualStudioWebService` - needs documentation.
1317

1418
### Applies To ###
1519

‎website/docs/editandcontinue.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If no value is set for a configuration, the toolset's default setting (usually "
88

99
### Parameters ###
1010

11-
`value` is a boolean value, i.e. "On" or "Off".
11+
`value` is a boolean value, i.e. "On" or "Off". Specifying "Default" will act the same as specifying no value, the toolset's default setting will be used.
1212

1313
### Applies To ###
1414

‎website/docs/exceptionhandling.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ exceptionhandling ("value")
1414
| On | Turn on exceptions. |
1515
| Off | Turn off exceptions. |
1616
| SEH | Turn on exceptions and use [structured exception handling](https://msdn.microsoft.com/en-us/library/windows/desktop/ms680657(v=vs.85).aspx) when available. |
17+
| CThrow | Needs documentation |
18+
| UnwindTables | Needs documentation |
1719

1820

1921
### Applies To ###

‎website/docs/flags.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,50 @@ flags { "flag_list" }
4040
| C++14 | Pass the c++14 flag to the gcc/clang compilers (msvc ignores this currently) |
4141
| C90 | Pass the c90 flag to the gcc/clang compilers (msvc ignores this currently) |
4242
| C99 | Pass the c99 flag to the gcc/clang compilers (msvc ignores this currently) |
43+
| Component | Needs documentation |
44+
| DebugEnvsDontMerge | Needs documentation |
45+
| DebugEnvsInherit | Needs documentation |
46+
| EnableSSE | Needs documentation |
47+
| EnableSSE2 | Needs documentation |
48+
| ExtraWarnings | Needs documentation |
49+
| FloatFast | Needs documentation |
50+
| FloatStrict | Needs documentation |
51+
| Managed | Needs documentation |
52+
| NoNativeWChar | Needs documentation |
53+
| NoEditAndContinue | Needs documentation |
54+
| NoWarnings | Needs documentation |
55+
| Optimize | Needs documentation |
56+
| OptimizeSize | Needs documentation |
57+
| OptimizeSpeed | Needs documentation |
58+
| ReleaseRuntime | Needs documentation |
59+
| Symbols | Needs documentation |
60+
| C11 | Needs documentation |
61+
| CodeCoverage | Needs documentation |
62+
| Color | Needs documentation |
63+
| Documentation | Needs documentation |
64+
| GenerateHeader | Needs documentation |
65+
| GenerateJSON | Needs documentation |
66+
| GenerateMap | Needs documentation |
67+
| LowMem | Needs documentation |
68+
| Profile | Needs documentation |
69+
| Quiet | Needs documentation |
70+
| RetainPaths | Needs documentation |
71+
| SymbolsLikeC | Needs documentation |
72+
| UnitTest | Needs documentation |
73+
| UseLDC | Needs documentation |
74+
| ProfileGC | Needs documentation |
75+
| StackFrame | Needs documentation |
76+
| StackStomp | Needs documentation |
77+
| AllInstantiate | Needs documentation |
78+
| BetterC | Needs documentation |
79+
| PerformSyntaxCheckOnly| Needs documentation |
80+
| ShowCommandLine | Needs documentation |
81+
| Verbose | Needs documentation |
82+
| ShowTLS | Needs documentation |
83+
| ShowGC | Needs documentation |
84+
| IgnorePragma | Needs documentation |
85+
| ShowDependencies | Needs documentation |
86+
| Thumb | Needs documentation |
4387

4488
### Applies To ###
4589

‎website/docs/floatingpoint.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ If no value is set for a configuration, the toolset's default floating point set
1515
| Default | Use the toolset's floating point settings. |
1616
| Fast | Enable floating point optimizations at the expense of accuracy. |
1717
| Strict | Improve floating point consistency at the expense of performance. |
18+
| None | Needs documentation |
1819

1920
### Applies To ###
2021

@@ -24,6 +25,8 @@ Project configurations.
2425

2526
Premake 5.0 or later.
2627

28+
The **None** option is only available for VisualD projects.
29+
2730
### Examples ###
2831

2932
```lua

‎website/docs/kind.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ kind ("kind")
1818
| Utility | A configuration which contains only custom build rules. |
1919
| None | A configuration which is not included in the build. Useful for projects containing only web pages, header files, or support documentation. |
2020
| Packaging | A configuration type to create .androidproj files, which build the apk in an Android application under Visual Studio. _Note, this was previously `AndroidProj`._ |
21+
| SharedItems | A special configuration type which doesn't contain any build settings of its own, instead using the build settings of any projects that link it. |
2122

2223

2324
### Applies To ###
@@ -28,6 +29,7 @@ Project configurations.
2829

2930
The **Makefile**, and **None** kinds are only available in Premake 5.0 and later, and are currently only supported for Visual Studio.
3031
The **Utility** kind is only available for Visual Studio and gmake2, as well as very limited support in gmake.
32+
The **SharedItems** kind is only available for Visual Studio 2013 and later.
3133

3234
### Examples ###
3335

0 commit comments

Comments
 (0)