From 0fb9327993b655609e91ddd4af961d9741faa488 Mon Sep 17 00:00:00 2001 From: Sam Surtees Date: Mon, 4 Oct 2021 19:20:00 +1000 Subject: [PATCH] Added action to check for missing documentation - Added auto-generated documentation files for APIs without docs - Renamed editAndContinue.md to editandcontinue.md to match convention --- .github/workflows/ci-workflow.yml | 7 +++ premake5.lua | 9 ++++ scripts/docscheck.lua | 14 +++++ website/docs/Migrating-From-4.x.md | 2 +- website/docs/Project-API.md | 2 +- website/docs/Whats-New-in-5.0.md | 4 +- website/docs/androidapilevel.md | 24 +++++++++ website/docs/androidapplibname.md | 24 +++++++++ website/docs/assemblydebug.md | 24 +++++++++ website/docs/boundscheck.md | 29 +++++++++++ website/docs/checkaction.md | 30 +++++++++++ website/docs/compilationmodel.md | 29 +++++++++++ website/docs/computetargets.md | 24 +++++++++ website/docs/conformancemode.md | 24 +++++++++ website/docs/debugformat.md | 4 +- website/docs/debuggerflavor.md | 29 +++++++++++ website/docs/dependenciesfile.md | 24 +++++++++ website/docs/deprecatedfeatures.md | 29 +++++++++++ ...{editAndContinue.md => editandcontinue.md} | 4 +- website/docs/embed.md | 24 +++++++++ website/docs/embedandsign.md | 24 +++++++++ website/docs/enabledefaultcompileitems.md | 24 +++++++++ website/docs/fastuptodate.md | 24 +++++++++ website/docs/floatabi.md | 28 ++++++++++ website/docs/frameworkdirs.md | 24 +++++++++ website/docs/importdirs.md | 24 +++++++++ website/docs/inlinesvisibility.md | 27 ++++++++++ website/docs/iosfamily.md | 28 ++++++++++ website/docs/isaextensions.md | 36 +++++++++++++ website/docs/jsonfile.md | 24 +++++++++ website/docs/omitframepointer.md | 28 ++++++++++ website/docs/preview.md | 33 ++++++++++++ website/docs/revert.md | 27 ++++++++++ website/docs/shaderassembler.md | 28 ++++++++++ website/docs/shaderassembleroutput.md | 24 +++++++++ website/docs/shaderdefines.md | 24 +++++++++ website/docs/shaderentry.md | 24 +++++++++ website/docs/shaderheaderfileoutput.md | 24 +++++++++ website/docs/shaderincludedirs.md | 24 +++++++++ website/docs/shadermodel.md | 41 +++++++++++++++ website/docs/shaderobjectfileoutput.md | 24 +++++++++ website/docs/shaderoptions.md | 24 +++++++++ website/docs/shadertype.md | 36 +++++++++++++ website/docs/shadervariablename.md | 24 +++++++++ website/docs/stl.md | 30 +++++++++++ website/docs/stringimportdirs.md | 24 +++++++++ website/docs/structmemberalign.md | 30 +++++++++++ website/docs/swiftversion.md | 28 ++++++++++ website/docs/tailcalls.md | 24 +++++++++ website/docs/thumbmode.md | 28 ++++++++++ website/docs/toolchainversion.md | 33 ++++++++++++ website/docs/transition.md | 30 +++++++++++ website/docs/unsignedchar.md | 24 +++++++++ website/docs/usefullpaths.md | 24 +++++++++ website/docs/xcodecodesigningidentity.md | 24 +++++++++ website/docs/xcodesystemcapabilities.md | 24 +++++++++ website/sidebars.js | 52 ++++++++++++++++++- 57 files changed, 1373 insertions(+), 10 deletions(-) create mode 100644 scripts/docscheck.lua create mode 100644 website/docs/androidapilevel.md create mode 100644 website/docs/androidapplibname.md create mode 100644 website/docs/assemblydebug.md create mode 100644 website/docs/boundscheck.md create mode 100644 website/docs/checkaction.md create mode 100644 website/docs/compilationmodel.md create mode 100644 website/docs/computetargets.md create mode 100644 website/docs/conformancemode.md create mode 100644 website/docs/debuggerflavor.md create mode 100644 website/docs/dependenciesfile.md create mode 100644 website/docs/deprecatedfeatures.md rename website/docs/{editAndContinue.md => editandcontinue.md} (90%) create mode 100644 website/docs/embed.md create mode 100644 website/docs/embedandsign.md create mode 100644 website/docs/enabledefaultcompileitems.md create mode 100644 website/docs/fastuptodate.md create mode 100644 website/docs/floatabi.md create mode 100644 website/docs/frameworkdirs.md create mode 100644 website/docs/importdirs.md create mode 100644 website/docs/inlinesvisibility.md create mode 100644 website/docs/iosfamily.md create mode 100644 website/docs/isaextensions.md create mode 100644 website/docs/jsonfile.md create mode 100644 website/docs/omitframepointer.md create mode 100644 website/docs/preview.md create mode 100644 website/docs/revert.md create mode 100644 website/docs/shaderassembler.md create mode 100644 website/docs/shaderassembleroutput.md create mode 100644 website/docs/shaderdefines.md create mode 100644 website/docs/shaderentry.md create mode 100644 website/docs/shaderheaderfileoutput.md create mode 100644 website/docs/shaderincludedirs.md create mode 100644 website/docs/shadermodel.md create mode 100644 website/docs/shaderobjectfileoutput.md create mode 100644 website/docs/shaderoptions.md create mode 100644 website/docs/shadertype.md create mode 100644 website/docs/shadervariablename.md create mode 100644 website/docs/stl.md create mode 100644 website/docs/stringimportdirs.md create mode 100644 website/docs/structmemberalign.md create mode 100644 website/docs/swiftversion.md create mode 100644 website/docs/tailcalls.md create mode 100644 website/docs/thumbmode.md create mode 100644 website/docs/toolchainversion.md create mode 100644 website/docs/transition.md create mode 100644 website/docs/unsignedchar.md create mode 100644 website/docs/usefullpaths.md create mode 100644 website/docs/xcodecodesigningidentity.md create mode 100644 website/docs/xcodesystemcapabilities.md diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml index e734fd4cb4..4c76729523 100644 --- a/.github/workflows/ci-workflow.yml +++ b/.github/workflows/ci-workflow.yml @@ -16,6 +16,8 @@ jobs: run: make -f Bootstrap.mak linux PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }} - name: Test run: bin/${{ matrix.config }}/premake5 test --test-all + - name: Docs check + run: bin/${{ matrix.config }}/premake5 docs-check - name: Upload Artifacts if: matrix.config == 'release' uses: actions/upload-artifact@v2 @@ -35,6 +37,8 @@ jobs: run: make -f Bootstrap.mak macosx PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }} - name: Test run: bin/${{ matrix.config }}/premake5 test --test-all + - name: Docs check + run: bin/${{ matrix.config }}/premake5 docs-check - name: Upload Artifacts if: matrix.config == 'release' uses: actions/upload-artifact@v2 @@ -58,6 +62,9 @@ jobs: - name: Test run: bin\${{ matrix.config }}\premake5 test --test-all shell: cmd + - name: Docs check + run: bin\${{ matrix.config }}\premake5 docs-check + shell: cmd - name: Upload Artifacts if: matrix.config == 'release' uses: actions/upload-artifact@v2 diff --git a/premake5.lua b/premake5.lua index 60f7ce8ddd..3b748b31d2 100644 --- a/premake5.lua +++ b/premake5.lua @@ -40,6 +40,15 @@ } + newaction { + trigger = "docs-check", + description = "Validates documentation files for Premake APIs", + execute = function () + include (path.join(corePath, "scripts/docscheck.lua")) + end + } + + newaction { trigger = "test", description = "Run the automated test suite", diff --git a/scripts/docscheck.lua b/scripts/docscheck.lua new file mode 100644 index 0000000000..bff81750a1 --- /dev/null +++ b/scripts/docscheck.lua @@ -0,0 +1,14 @@ +--- +-- Validate documentation for Premkake APIs. +--- + + local count = 0 + for k,v in pairs(premake.field._loweredList) do + local docfilepath = "../website/docs/" .. k .. ".md" + local exists = os.isfile(docfilepath) + if not exists then + print("Missing documentation file for: ", k) + count = count + 1 + end + end + os.exit(count) \ No newline at end of file diff --git a/website/docs/Migrating-From-4.x.md b/website/docs/Migrating-From-4.x.md index d65fe52bec..e4f885f343 100644 --- a/website/docs/Migrating-From-4.x.md +++ b/website/docs/Migrating-From-4.x.md @@ -19,6 +19,6 @@ Many of the old [`flags`](flags.md) have become full-fledged functions. This sho | `FloatFast`, `FloatStrict` | [`floatingpoint`](floatingpoint.md) | | `Managed`, `Unsafe` | [`clr`](clr.md) | | `NativeWChar` | [`nativewchar`](nativewchar.md) | -| `NoEditAndContinue` | [`editandcontinue`](editAndContinue.md) | +| `NoEditAndContinue` | [`editandcontinue`](editandcontinue.md) | | `NoRTTI` | [`rtti`](rtti.md) | | `OptimizeSize`, `OptimizeSpeed` | [`optimize`](optimize.md) | diff --git a/website/docs/Project-API.md b/website/docs/Project-API.md index 7902505722..4ef93b2802 100644 --- a/website/docs/Project-API.md +++ b/website/docs/Project-API.md @@ -69,7 +69,7 @@ | [display](display.md) | | | [docdir](docdir.md) | | | [docname](docname.md) | | -| [editandcontinue](editAndContinue.md) | | +| [editandcontinue](editandcontinue.md) | | | [editorintegration](editorintegration.md) | Enable or disable IDE integration | | [enablewarnings](enablewarnings.md) | | | [endian](endian.md) | | diff --git a/website/docs/Whats-New-in-5.0.md b/website/docs/Whats-New-in-5.0.md index 6726d61a22..d752fcce70 100644 --- a/website/docs/Whats-New-in-5.0.md +++ b/website/docs/Whats-New-in-5.0.md @@ -63,7 +63,7 @@ title: What's New in 5.0 * [dependson](dependson.md) (new) * [disablewarnings](disablewarnings.md) (new) * [dotnetframework](dotnetframework.md) (new) -* [editandcontinue](editAndContinue.md) (new, replaces flag `NoEditAndContinue`) +* [editandcontinue](editandcontinue.md) (new, replaces flag `NoEditAndContinue`) * [editorintegration](editorintegration.md) (new) * [enablewarnings](enablewarnings.md) (new) * [endian](endian.md) (new) @@ -151,6 +151,6 @@ title: What's New in 5.0 * FloatFast, FloatStrict: use [floatingpoint](floatingpoint.md) instead * Managed, Unsafe: use [clr](clr.md) instead * NativeWChar: use [nativewchar](nativewchar.md) instead - * NoEditAndContinue: use [editandcontinue](editAndContinue.md) instead + * NoEditAndContinue: use [editandcontinue](editandcontinue.md) instead * NoRTTI: use [rtti](rtti.md) instead. * OptimizeSize, OptimizeSpeed: use [optimize](optimize.md) instead diff --git a/website/docs/androidapilevel.md b/website/docs/androidapilevel.md new file mode 100644 index 0000000000..227b5b6ff5 --- /dev/null +++ b/website/docs/androidapilevel.md @@ -0,0 +1,24 @@ +androidapilevel - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +androidapilevel (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +androidapilevel (value) +``` + diff --git a/website/docs/androidapplibname.md b/website/docs/androidapplibname.md new file mode 100644 index 0000000000..55e161ebc6 --- /dev/null +++ b/website/docs/androidapplibname.md @@ -0,0 +1,24 @@ +androidapplibname - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +androidapplibname (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +androidapplibname (value) +``` + diff --git a/website/docs/assemblydebug.md b/website/docs/assemblydebug.md new file mode 100644 index 0000000000..7c996b5752 --- /dev/null +++ b/website/docs/assemblydebug.md @@ -0,0 +1,24 @@ +assemblydebug - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +assemblydebug (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +assemblydebug (value) +``` + diff --git a/website/docs/boundscheck.md b/website/docs/boundscheck.md new file mode 100644 index 0000000000..843499aaf1 --- /dev/null +++ b/website/docs/boundscheck.md @@ -0,0 +1,29 @@ +boundscheck - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +boundscheck (value) +``` + +### Parameters ### + +`value` is one of: + +* `Default`: needs documentation +* `Off`: needs documentation +* `On`: needs documentation +* `SafeOnly`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +boundscheck (value) +``` + diff --git a/website/docs/checkaction.md b/website/docs/checkaction.md new file mode 100644 index 0000000000..98f649e7e2 --- /dev/null +++ b/website/docs/checkaction.md @@ -0,0 +1,30 @@ +checkaction - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +checkaction (value) +``` + +### Parameters ### + +`value` is one of: + +* `Default`: needs documentation +* `D`: needs documentation +* `C`: needs documentation +* `Halt`: needs documentation +* `Context`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +checkaction (value) +``` + diff --git a/website/docs/compilationmodel.md b/website/docs/compilationmodel.md new file mode 100644 index 0000000000..79983d2926 --- /dev/null +++ b/website/docs/compilationmodel.md @@ -0,0 +1,29 @@ +compilationmodel - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +compilationmodel (value) +``` + +### Parameters ### + +`value` is one of: + +* `Default`: needs documentation +* `File`: needs documentation +* `Package`: needs documentation +* `Project`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +compilationmodel (value) +``` + diff --git a/website/docs/computetargets.md b/website/docs/computetargets.md new file mode 100644 index 0000000000..fa5089c573 --- /dev/null +++ b/website/docs/computetargets.md @@ -0,0 +1,24 @@ +computetargets - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +computetargets (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +computetargets (value) +``` + diff --git a/website/docs/conformancemode.md b/website/docs/conformancemode.md new file mode 100644 index 0000000000..db4f0673b4 --- /dev/null +++ b/website/docs/conformancemode.md @@ -0,0 +1,24 @@ +conformancemode - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +conformancemode (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 beta 1 or later. + +### Examples ### + +```lua +conformancemode (value) +``` + diff --git a/website/docs/debugformat.md b/website/docs/debugformat.md index 1a47ff9393..16fe8dee3d 100644 --- a/website/docs/debugformat.md +++ b/website/docs/debugformat.md @@ -12,7 +12,7 @@ debugformat "format" |-------------|---------------------------------------------------------------------------------------------| | c7 | Specifies that MSVC should store debuginfo in the objects rather than a separate .pdb file. | -**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. +**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. ### Applies To ### @@ -24,5 +24,5 @@ Premake 5.0 or later. ### See Also ### -- [editAndContinue](editAndContinue.md) +- [editandcontinue](editandcontinue.md) diff --git a/website/docs/debuggerflavor.md b/website/docs/debuggerflavor.md new file mode 100644 index 0000000000..c2a37935b9 --- /dev/null +++ b/website/docs/debuggerflavor.md @@ -0,0 +1,29 @@ +debuggerflavor - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +debuggerflavor (value) +``` + +### Parameters ### + +`value` is one of: + +* `Local`: needs documentation +* `Remote`: needs documentation +* `WebBrowser`: needs documentation +* `WebService`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +debuggerflavor (value) +``` + diff --git a/website/docs/dependenciesfile.md b/website/docs/dependenciesfile.md new file mode 100644 index 0000000000..d3e2b7bf5a --- /dev/null +++ b/website/docs/dependenciesfile.md @@ -0,0 +1,24 @@ +dependenciesfile - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +dependenciesfile (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +dependenciesfile (value) +``` + diff --git a/website/docs/deprecatedfeatures.md b/website/docs/deprecatedfeatures.md new file mode 100644 index 0000000000..a80979e1c6 --- /dev/null +++ b/website/docs/deprecatedfeatures.md @@ -0,0 +1,29 @@ +deprecatedfeatures - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +deprecatedfeatures (value) +``` + +### Parameters ### + +`value` is one of: + +* `Default`: needs documentation +* `Allow`: needs documentation +* `Warn`: needs documentation +* `Error`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +deprecatedfeatures (value) +``` + diff --git a/website/docs/editAndContinue.md b/website/docs/editandcontinue.md similarity index 90% rename from website/docs/editAndContinue.md rename to website/docs/editandcontinue.md index 543e678bb1..f1b598f9bb 100644 --- a/website/docs/editAndContinue.md +++ b/website/docs/editandcontinue.md @@ -1,7 +1,7 @@ Turns the edit-and-continue features of a toolset or platform on and off. ```lua -editAndContinue "value" +editandcontinue "value" ``` If no value is set for a configuration, the toolset's default setting (usually "On") will be used. @@ -22,7 +22,7 @@ Premake 5.0 or later. ```lua -- Turn off edit and continue -editAndContinue "Off" +editandcontinue "Off" ``` ### See Also ### diff --git a/website/docs/embed.md b/website/docs/embed.md new file mode 100644 index 0000000000..74cfa063de --- /dev/null +++ b/website/docs/embed.md @@ -0,0 +1,24 @@ +embed - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +embed (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 beta 1 or later. + +### Examples ### + +```lua +embed (value) +``` + diff --git a/website/docs/embedandsign.md b/website/docs/embedandsign.md new file mode 100644 index 0000000000..bc8f67d5c7 --- /dev/null +++ b/website/docs/embedandsign.md @@ -0,0 +1,24 @@ +embedandsign - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +embedandsign (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 beta 1 or later. + +### Examples ### + +```lua +embedandsign (value) +``` + diff --git a/website/docs/enabledefaultcompileitems.md b/website/docs/enabledefaultcompileitems.md new file mode 100644 index 0000000000..ad770ab365 --- /dev/null +++ b/website/docs/enabledefaultcompileitems.md @@ -0,0 +1,24 @@ +enabledefaultcompileitems - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +enabledefaultcompileitems (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +enabledefaultcompileitems (value) +``` + diff --git a/website/docs/fastuptodate.md b/website/docs/fastuptodate.md new file mode 100644 index 0000000000..780a514c6b --- /dev/null +++ b/website/docs/fastuptodate.md @@ -0,0 +1,24 @@ +fastuptodate - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +fastuptodate (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `project` scope. + +### Availability ### + +Premake 5.0.0 beta 1 or later. + +### Examples ### + +```lua +fastuptodate (value) +``` + diff --git a/website/docs/floatabi.md b/website/docs/floatabi.md new file mode 100644 index 0000000000..76e385c190 --- /dev/null +++ b/website/docs/floatabi.md @@ -0,0 +1,28 @@ +floatabi - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +floatabi (value) +``` + +### Parameters ### + +`value` is one of: + +* `soft`: needs documentation +* `softfp`: needs documentation +* `hard`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +floatabi (value) +``` + diff --git a/website/docs/frameworkdirs.md b/website/docs/frameworkdirs.md new file mode 100644 index 0000000000..60fcd7132f --- /dev/null +++ b/website/docs/frameworkdirs.md @@ -0,0 +1,24 @@ +frameworkdirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +frameworkdirs (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 11 or later. + +### Examples ### + +```lua +frameworkdirs (value) +``` + diff --git a/website/docs/importdirs.md b/website/docs/importdirs.md new file mode 100644 index 0000000000..ac754577fa --- /dev/null +++ b/website/docs/importdirs.md @@ -0,0 +1,24 @@ +importdirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +importdirs (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +importdirs (value) +``` + diff --git a/website/docs/inlinesvisibility.md b/website/docs/inlinesvisibility.md new file mode 100644 index 0000000000..f43200fc1f --- /dev/null +++ b/website/docs/inlinesvisibility.md @@ -0,0 +1,27 @@ +inlinesvisibility - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +inlinesvisibility (value) +``` + +### Parameters ### + +`value` is one of: + +* `Default`: needs documentation +* `Hidden`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +inlinesvisibility (value) +``` + diff --git a/website/docs/iosfamily.md b/website/docs/iosfamily.md new file mode 100644 index 0000000000..d8cf84b4e0 --- /dev/null +++ b/website/docs/iosfamily.md @@ -0,0 +1,28 @@ +iosfamily - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +iosfamily (value) +``` + +### Parameters ### + +`value` is one of: + +* `iPhone/iPod touch`: needs documentation +* `iPad`: needs documentation +* `Universal`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +iosfamily (value) +``` + diff --git a/website/docs/isaextensions.md b/website/docs/isaextensions.md new file mode 100644 index 0000000000..b6b6afcfcd --- /dev/null +++ b/website/docs/isaextensions.md @@ -0,0 +1,36 @@ +isaextensions - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +isaextensions (value) +``` + +### Parameters ### + +`value` is one of: + +* `MOVBE`: needs documentation +* `POPCNT`: needs documentation +* `PCLMUL`: needs documentation +* `LZCNT`: needs documentation +* `BMI`: needs documentation +* `BMI2`: needs documentation +* `F16C`: needs documentation +* `AES`: needs documentation +* `FMA`: needs documentation +* `FMA4`: needs documentation +* `RDRND`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +isaextensions (value) +``` + diff --git a/website/docs/jsonfile.md b/website/docs/jsonfile.md new file mode 100644 index 0000000000..0ef836d2be --- /dev/null +++ b/website/docs/jsonfile.md @@ -0,0 +1,24 @@ +jsonfile - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +jsonfile (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +jsonfile (value) +``` + diff --git a/website/docs/omitframepointer.md b/website/docs/omitframepointer.md new file mode 100644 index 0000000000..9dac9ba3d5 --- /dev/null +++ b/website/docs/omitframepointer.md @@ -0,0 +1,28 @@ +omitframepointer - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +omitframepointer (value) +``` + +### Parameters ### + +`value` is one of: + +* `Default`: needs documentation +* `On`: needs documentation +* `Off`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +omitframepointer (value) +``` + diff --git a/website/docs/preview.md b/website/docs/preview.md new file mode 100644 index 0000000000..a9b7ef1cbf --- /dev/null +++ b/website/docs/preview.md @@ -0,0 +1,33 @@ +preview - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +preview (value) +``` + +### Parameters ### + +`value` is one of: + +* `dip25`: needs documentation +* `dip1000`: needs documentation +* `dip1008`: needs documentation +* `fieldwise`: needs documentation +* `markdown`: needs documentation +* `fixAliasThis`: needs documentation +* `intpromote`: needs documentation +* `dtorfields`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +preview (value) +``` + diff --git a/website/docs/revert.md b/website/docs/revert.md new file mode 100644 index 0000000000..d5036b3cd9 --- /dev/null +++ b/website/docs/revert.md @@ -0,0 +1,27 @@ +revert - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +revert (value) +``` + +### Parameters ### + +`value` is one of: + +* `dip25`: needs documentation +* `import`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +revert (value) +``` + diff --git a/website/docs/shaderassembler.md b/website/docs/shaderassembler.md new file mode 100644 index 0000000000..ac3b402264 --- /dev/null +++ b/website/docs/shaderassembler.md @@ -0,0 +1,28 @@ +shaderassembler - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderassembler (value) +``` + +### Parameters ### + +`value` is one of: + +* `NoListing`: needs documentation +* `AssemblyCode`: needs documentation +* `AssemblyCodeAndHex`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderassembler (value) +``` + diff --git a/website/docs/shaderassembleroutput.md b/website/docs/shaderassembleroutput.md new file mode 100644 index 0000000000..95ca3d487f --- /dev/null +++ b/website/docs/shaderassembleroutput.md @@ -0,0 +1,24 @@ +shaderassembleroutput - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderassembleroutput (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderassembleroutput (value) +``` + diff --git a/website/docs/shaderdefines.md b/website/docs/shaderdefines.md new file mode 100644 index 0000000000..b587daa1e4 --- /dev/null +++ b/website/docs/shaderdefines.md @@ -0,0 +1,24 @@ +shaderdefines - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderdefines (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderdefines (value) +``` + diff --git a/website/docs/shaderentry.md b/website/docs/shaderentry.md new file mode 100644 index 0000000000..20ce3220b3 --- /dev/null +++ b/website/docs/shaderentry.md @@ -0,0 +1,24 @@ +shaderentry - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderentry (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderentry (value) +``` + diff --git a/website/docs/shaderheaderfileoutput.md b/website/docs/shaderheaderfileoutput.md new file mode 100644 index 0000000000..d229cc1221 --- /dev/null +++ b/website/docs/shaderheaderfileoutput.md @@ -0,0 +1,24 @@ +shaderheaderfileoutput - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderheaderfileoutput (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderheaderfileoutput (value) +``` + diff --git a/website/docs/shaderincludedirs.md b/website/docs/shaderincludedirs.md new file mode 100644 index 0000000000..89eb1cdec8 --- /dev/null +++ b/website/docs/shaderincludedirs.md @@ -0,0 +1,24 @@ +shaderincludedirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderincludedirs (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +shaderincludedirs (value) +``` + diff --git a/website/docs/shadermodel.md b/website/docs/shadermodel.md new file mode 100644 index 0000000000..408270aee1 --- /dev/null +++ b/website/docs/shadermodel.md @@ -0,0 +1,41 @@ +shadermodel - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shadermodel (value) +``` + +### Parameters ### + +`value` is one of: + +* `2.0`: needs documentation +* `3.0`: needs documentation +* `4.0_level_9_1`: needs documentation +* `4.0_level_9_3`: needs documentation +* `4.0`: needs documentation +* `4.1`: needs documentation +* `5.0`: needs documentation +* `5.1`: needs documentation +* `rootsig_1.0`: needs documentation +* `rootsig_1.1`: needs documentation +* `6.0`: needs documentation +* `6.1`: needs documentation +* `6.2`: needs documentation +* `6.3`: needs documentation +* `6.4`: needs documentation +* `6.5`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shadermodel (value) +``` + diff --git a/website/docs/shaderobjectfileoutput.md b/website/docs/shaderobjectfileoutput.md new file mode 100644 index 0000000000..82fe629b52 --- /dev/null +++ b/website/docs/shaderobjectfileoutput.md @@ -0,0 +1,24 @@ +shaderobjectfileoutput - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderobjectfileoutput (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderobjectfileoutput (value) +``` + diff --git a/website/docs/shaderoptions.md b/website/docs/shaderoptions.md new file mode 100644 index 0000000000..b420a75cee --- /dev/null +++ b/website/docs/shaderoptions.md @@ -0,0 +1,24 @@ +shaderoptions - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shaderoptions (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shaderoptions (value) +``` + diff --git a/website/docs/shadertype.md b/website/docs/shadertype.md new file mode 100644 index 0000000000..a73f01d5a0 --- /dev/null +++ b/website/docs/shadertype.md @@ -0,0 +1,36 @@ +shadertype - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shadertype (value) +``` + +### Parameters ### + +`value` is one of: + +* `Effect`: needs documentation +* `Vertex`: needs documentation +* `Pixel`: needs documentation +* `Geometry`: needs documentation +* `Hull`: needs documentation +* `Domain`: needs documentation +* `Compute`: needs documentation +* `Mesh`: needs documentation +* `Amplification`: needs documentation +* `Texture`: needs documentation +* `RootSignature`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shadertype (value) +``` + diff --git a/website/docs/shadervariablename.md b/website/docs/shadervariablename.md new file mode 100644 index 0000000000..f834058e58 --- /dev/null +++ b/website/docs/shadervariablename.md @@ -0,0 +1,24 @@ +shadervariablename - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +shadervariablename (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +shadervariablename (value) +``` + diff --git a/website/docs/stl.md b/website/docs/stl.md new file mode 100644 index 0000000000..b3fc22eb62 --- /dev/null +++ b/website/docs/stl.md @@ -0,0 +1,30 @@ +stl - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +stl (value) +``` + +### Parameters ### + +`value` is one of: + +* `none`: needs documentation +* `gabi++`: needs documentation +* `stlport`: needs documentation +* `gnu`: needs documentation +* `libc++`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +stl (value) +``` + diff --git a/website/docs/stringimportdirs.md b/website/docs/stringimportdirs.md new file mode 100644 index 0000000000..7531858b31 --- /dev/null +++ b/website/docs/stringimportdirs.md @@ -0,0 +1,24 @@ +stringimportdirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +stringimportdirs (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +stringimportdirs (value) +``` + diff --git a/website/docs/structmemberalign.md b/website/docs/structmemberalign.md new file mode 100644 index 0000000000..027e882af8 --- /dev/null +++ b/website/docs/structmemberalign.md @@ -0,0 +1,30 @@ +structmemberalign - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +structmemberalign (value) +``` + +### Parameters ### + +`value` is one of: + +* `1`: needs documentation +* `2`: needs documentation +* `4`: needs documentation +* `8`: needs documentation +* `16`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +structmemberalign (value) +``` + diff --git a/website/docs/swiftversion.md b/website/docs/swiftversion.md new file mode 100644 index 0000000000..b34ffbf7f5 --- /dev/null +++ b/website/docs/swiftversion.md @@ -0,0 +1,28 @@ +swiftversion - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +swiftversion (value) +``` + +### Parameters ### + +`value` is one of: + +* `4.0`: needs documentation +* `4.2`: needs documentation +* `5.0`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 beta 1 or later. + +### Examples ### + +```lua +swiftversion (value) +``` + diff --git a/website/docs/tailcalls.md b/website/docs/tailcalls.md new file mode 100644 index 0000000000..bc3dbb1e81 --- /dev/null +++ b/website/docs/tailcalls.md @@ -0,0 +1,24 @@ +tailcalls - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +tailcalls (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +tailcalls (value) +``` + diff --git a/website/docs/thumbmode.md b/website/docs/thumbmode.md new file mode 100644 index 0000000000..4fbf369238 --- /dev/null +++ b/website/docs/thumbmode.md @@ -0,0 +1,28 @@ +thumbmode - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +thumbmode (value) +``` + +### Parameters ### + +`value` is one of: + +* `thumb`: needs documentation +* `arm`: needs documentation +* `disabled`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +thumbmode (value) +``` + diff --git a/website/docs/toolchainversion.md b/website/docs/toolchainversion.md new file mode 100644 index 0000000000..270adcb5f4 --- /dev/null +++ b/website/docs/toolchainversion.md @@ -0,0 +1,33 @@ +toolchainversion - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +toolchainversion (value) +``` + +### Parameters ### + +`value` is one of: + +* `4.6`: needs documentation +* `4.8`: needs documentation +* `4.9`: needs documentation +* `3.4`: needs documentation +* `3.5`: needs documentation +* `3.6`: needs documentation +* `3.8`: needs documentation +* `5.0`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +toolchainversion (value) +``` + diff --git a/website/docs/transition.md b/website/docs/transition.md new file mode 100644 index 0000000000..db0e38b3a9 --- /dev/null +++ b/website/docs/transition.md @@ -0,0 +1,30 @@ +transition - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +transition (value) +``` + +### Parameters ### + +`value` is one of: + +* `field`: needs documentation +* `checkimports`: needs documentation +* `complex`: needs documentation +* `tls`: needs documentation +* `vmarkdown`: needs documentation + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 16 or later. + +### Examples ### + +```lua +transition (value) +``` + diff --git a/website/docs/unsignedchar.md b/website/docs/unsignedchar.md new file mode 100644 index 0000000000..4db8026f97 --- /dev/null +++ b/website/docs/unsignedchar.md @@ -0,0 +1,24 @@ +unsignedchar - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +unsignedchar (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +unsignedchar (value) +``` + diff --git a/website/docs/usefullpaths.md b/website/docs/usefullpaths.md new file mode 100644 index 0000000000..e40084d6e2 --- /dev/null +++ b/website/docs/usefullpaths.md @@ -0,0 +1,24 @@ +usefullpaths - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +usefullpaths (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 beta 1 or later. + +### Examples ### + +```lua +usefullpaths (value) +``` + diff --git a/website/docs/xcodecodesigningidentity.md b/website/docs/xcodecodesigningidentity.md new file mode 100644 index 0000000000..8d80d88205 --- /dev/null +++ b/website/docs/xcodecodesigningidentity.md @@ -0,0 +1,24 @@ +xcodecodesigningidentity - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +xcodecodesigningidentity (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `config` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +xcodecodesigningidentity (value) +``` + diff --git a/website/docs/xcodesystemcapabilities.md b/website/docs/xcodesystemcapabilities.md new file mode 100644 index 0000000000..668f590577 --- /dev/null +++ b/website/docs/xcodesystemcapabilities.md @@ -0,0 +1,24 @@ +xcodesystemcapabilities - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request. + +```lua +xcodesystemcapabilities (value) +``` + +### Parameters ### + +`value` - needs documentation. + +## Applies To ### + +The `project` scope. + +### Availability ### + +Premake 5.0.0 alpha 14 or later. + +### Examples ### + +```lua +xcodesystemcapabilities (value) +``` + diff --git a/website/sidebars.js b/website/sidebars.js index 65d9c8b9da..6b7cde184c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -60,10 +60,14 @@ module.exports = { type: 'category', label: 'Project Settings', items: [ + 'androidapilevel', + 'androidapplibname', 'architecture', + 'assemblydebug', 'atl', 'basedir', 'bindirs', + 'boundscheck', 'buildaction', 'buildcommands', 'buildcustomizations', @@ -77,15 +81,19 @@ module.exports = { 'callingconvention', 'cdialect', 'characterset', + 'checkaction', 'cleancommands', 'cleanextensions', 'clr', + 'compilationmodel', 'compileas', 'compilebuildoutputs', + 'computetargets', 'configfile', 'configmap', 'configuration', 'configurations', + 'conformancemode', 'copylocal', 'cppdialect', 'csversion', @@ -100,6 +108,7 @@ module.exports = { 'debugextendedprotocol', 'debugformat', 'debugger', + 'debuggerflavor', 'debuggertype', 'debuglevel', 'debugpathmap', @@ -111,8 +120,10 @@ module.exports = { 'debugtoolcommand', 'defaultplatform', 'defines', + 'dependenciesfile', 'dependson', 'deploymentoptions', + 'deprecatedfeatures', 'disablewarnings', 'display', 'docdir', @@ -120,8 +131,11 @@ module.exports = { 'dofileopt', 'dotnetframework', 'dpiawareness', - 'editAndContinue', + 'editandcontinue', 'editorintegration', + 'embed', + 'embedandsign', + 'enabledefaultcompileitems', 'enablewarnings', 'endian', 'entrypoint', @@ -129,18 +143,21 @@ module.exports = { 'external', 'externalproject', 'externalrule', + 'fastuptodate', 'fatalwarnings', 'fileextension', 'filename', 'files', 'filter', 'flags', + 'floatabi', 'floatingpoint', 'floatingpointexceptions', 'forceincludes', 'forceusings', 'fpu', 'framework', + 'frameworkdirs', 'functionlevellinking', 'gccprefix', 'group', @@ -155,9 +172,14 @@ module.exports = { 'implibname', 'implibprefix', 'implibsuffix', + 'importdirs', 'includedirs', + 'inlinesvisibility', 'inlining', 'intrinsics', + 'iosfamily', + 'isaextensions', + 'jsonfile', 'justmycode', 'kind', 'language', @@ -177,6 +199,7 @@ module.exports = { 'nuget', 'nugetsource', 'objdir', + 'omitframepointer', 'openmp', 'optimize', 'pchheader', @@ -190,6 +213,7 @@ module.exports = { 'preferredtoolarchitecture', 'prelinkcommands', 'prelinkmessage', + 'preview', 'project', 'propertydefinition', 'rebuildcommands', @@ -198,16 +222,32 @@ module.exports = { 'resincludedirs', 'resoptions', 'resourcegenerator', + 'revert', 'rtti', 'rule', 'rules', 'runpathdirs', 'runtime', + 'shaderassembler', + 'shaderassembleroutput', + 'shaderdefines', + 'shaderentry', + 'shaderheaderfileoutput', + 'shaderincludedirs', + 'shadermodel', + 'shaderobjectfileoutput', + 'shaderoptions', + 'shadertype', + 'shadervariablename', 'sharedlibtype', 'startproject', 'staticruntime', + 'stl', 'strictaliasing', + 'stringimportdirs', 'stringpooling', + 'structmemberalign', + 'swiftversion', 'symbols', 'symbolspath', 'sysincludedirs', @@ -215,14 +255,20 @@ module.exports = { 'system', 'systemversion', 'tags', + 'tailcalls', 'targetdir', 'targetextension', 'targetname', 'targetprefix', 'targetsuffix', + 'thumbmode', + 'toolchainversion', 'toolset', 'toolsversion', + 'transition', 'undefines', + 'unsignedchar', + 'usefullpaths', 'usingdirs', 'uuid', 'vectorextensions', @@ -233,7 +279,9 @@ module.exports = { 'warnings', 'workspace', 'xcodebuildresources', - 'xcodebuildsettings' + 'xcodebuildsettings', + 'xcodecodesigningidentity', + 'xcodesystemcapabilities' ] }, {