AuroraPipeline/premake
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 1 Wiki Activity

Merge pull request #1959 from thomashope/master

Browse Source 
Use admonitions in documentation for things marked as deprecated
This commit is contained in:
Samuel Surtees 2022-09-19 21:01:46 +10:00 committed by GitHub
commit 0078c17a8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/docs/Tokens.md
View File

@ -76,7 +76,7 @@ Command tokens represent a system level command in a platform-neutral way.
```lua
postbuildcommands {
"{COPY} file1.txt file2.txt"
"{COPYFILE} file1.txt file2.txt"
}
```
@ -108,8 +108,13 @@ The available tokens, and their replacements:
| {RMDIR} | rmdir /S /Q {args} | rm -rf {args} |
| {TOUCH} | type nul >> {arg} && copy /b {arg}+,, {arg} | touch {args} |
Note that this token exists but is deprecated in favor of {COPYDIR} and {COPYFILE}
| {COPY} | xcopy /Q /E /Y /I {args} | cp -rf {args} |
:::caution
The following tokens are deprecated:
:::
| Token | DOS | Posix | Remarks |
|------------|---------------------------------------------|-----------------|-------------------------------------|
| {COPY} | xcopy /Q /E /Y /I {args} | cp -rf {args} | Use {COPYDIR} or {COPYFILE} instead |
## Tokens and Filters

6
website/docs/configuration.md
View File

@ -1,11 +1,13 @@
:::caution
**This function has been deprecated in Premake 5.0 beta1.** Use the new [filter()](filter.md) function instead; you will get more granular matching and much better performance. `configuration()` will be not supported in Premake 6.
:::
Limits the subsequent build settings to a particular environment.
```lua
configuration { "keywords" }
```
**This function has been deprecated in Premake 5.0 beta1.** Use the new [filter()](filter.md) function instead; you will get more granular matching and much better performance. `configuration()` will be not supported in Premake 6.
### Parameters ###
`keywords` is a list of identifiers (see below). When all of the keywords in this list match Premake's current context, the settings that follow the `configuration` statement will be applied. If any of the identifiers are not in the current context the settings will be ignored.

8
website/docs/framework.md
View File

@ -1,3 +1,7 @@
:::caution
**This API is deprecated since 5.0**, please use [dotnetframework](dotnetframework.md) instead.
:::
Selects a .NET framework version.
```lua
@ -33,10 +37,6 @@ Use the .NET 3.0 Framework.
framework "3.0"
```
### Remarks ###
This API is deprecated since 5.0, please use [dotnetframework](dotnetframework.md) instead.
### See Also ###
* [clr](clr.md)

10
website/docs/newaction.md
View File

@ -14,14 +14,12 @@ newaction { description }
| shortname | A short summary for the help text, e.g. "Visual Studio 2013". |
| description | A description of the action's result, e.g. "Generate Visual Studio 2013 project files". |
| execute | A function to be executed when the action is fired. |
| os | Deprecated, use targetos instead. |
| targetos | If the toolset targets a specific OS, the [identifier](system.md) for that OS. |
| valid_kinds | The list of [project kinds](kind.md) supported by the action. |
| valid_languages | The list of [languages](language.md) supported by the action. |
| valid_tools | The list of [tools](toolset.md) supported by the action. |
| toolset | Default [tools](toolset.md). |
| onStart | A callback marking the start of action processing. |
| onSolution | Deprecated, use onWorkspace instead. |
| onWorkspace | A callback for each workspace specified in the user script. |
| onProject | A callback for each project specified in the user script. |
| onRule | A callback for each rule specified in the user script. |
@ -40,6 +38,14 @@ The callbacks will fire in this order:
4. `execute()`
5. `onEnd()`
:::caution
The following fields have been deprecated:
:::
| Field | Description |
|-------------|------------------------------------------------------------------------------------|
| os | Deprecated, use targetos instead. |
| onSolution | Deprecated, use onWorkspace instead. |
### Availability ###

5
website/docs/sysincludedirs.md
View File

@ -1,10 +1,13 @@
:::caution
**This function has been deprecated in Premake 5.0 beta2.** Use the new [externalincludedirs](externalincludedirs.md) function instead. `sysincludedirs` will be not supported in Premake 6.
:::
Alias of [externalincludedirs](externalincludedirs.md).
```lua
sysincludedirs { "paths" }
```
**This function has been deprecated in Premake 5.0 beta2.** Use the new [externalincludedirs](externalincludedirs.md) function instead. `sysincludedirs` will be not supported in Premake 6.
### Parameters ###