Skip to content

Commit 7cf27c2

Browse files
tritaotritao
committed
Re-organize docs structure into sub-folders.
1 parent 6d3c962 commit 7cf27c2

File tree

137 files changed

+273
-272
lines changed

Some content is hidden

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

137 files changed

+273
-272
lines changed

‎website/docs/Command-Line-Arguments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ An _action_ indicates what Premake should do on any given run. For instance, the
1212

1313
An _option_ modifies the behavior of the action. For instance, the `dotnet` option is used to change which .NET compiler set is used in the generated files. Options can accept a value, such as `--dotnet=mono` or act as a flag, like `--with-opengl`.
1414

15-
From within your script, you can identify the current action with the [`_ACTION`](premake_ACTION.md) global variable, a string value. You can check for an option using the [`_OPTIONS`](premake_OPTIONS.md) table, which contains a list of key-value pairs. The key is the option identifier ("dotnet"), which references the command line value ("mono") or an empty string for valueless options.
15+
From within your script, you can identify the current action with the [`_ACTION`](globals/premake_ACTION.md) global variable, a string value. You can check for an option using the [`_OPTIONS`](globals/premake_OPTIONS.md) table, which contains a list of key-value pairs. The key is the option identifier ("dotnet"), which references the command line value ("mono") or an empty string for valueless options.
1616

1717
```lua
1818
-- delete a file if the clean action is running

‎website/docs/Linking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can tell Premake where to search for libraries with the [`libdirs`](libdirs.
3535
libdirs { "libs", "../mylibs" }
3636
```
3737

38-
If you need to discover the location of a library, use the [`os.findlib`](os.findlib.md) function.
38+
If you need to discover the location of a library, use the [`os.findlib`](os/os.findlib.md) function.
3939

4040
```lua
4141
libdirs { os.findlib("X11") }

‎website/docs/Lua-Library-Additions.md

+102-102
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
### Globals
22

3-
* [dofileopt](dofileopt.md)
4-
* [include](include.md)
5-
* [includeexternal](includeexternal.md)
6-
* [require](require.md)
3+
* [dofileopt](globals/dofileopt.md)
4+
* [include](globals/include.md)
5+
* [includeexternal](globals/includeexternal.md)
6+
* [require](globals/require.md)
77

88
### Debugging
99

1010
* [debug.prompt](debug.prompt.md)
1111

1212
### HTTP/S
1313

14-
* [http.download](http.download.md)
15-
* [http.get](http.get.md)
16-
* [http.post](http.post.md)
14+
* [http.download](http/http.download.md)
15+
* [http.get](http/http.get.md)
16+
* [http.post](http/http.post.md)
1717

1818
### I/O
1919

@@ -22,117 +22,117 @@
2222

2323
### JSON
2424

25-
* [json.decode](json.decode.md)
26-
* [json.encode](json.encode.md)
25+
* [json.decode](json/json.decode.md)
26+
* [json.encode](json/json.encode.md)
2727

2828
### OS
2929

30-
* [os.chdir](os.chdir.md)
31-
* [os.chmod](os.chmod.md)
32-
* [os.comparefiles](os.comparefiles.md)
33-
* [os.copyfile](os.copyfile.md)
34-
* [os.executef](os.executef.md)
35-
* [os.findheader](os.findheader.md)
36-
* [os.findlib](os.findlib.md)
37-
* [os.get](os.get.md)
38-
* [os.getcwd](os.getcwd.md)
39-
* [os.getpass](os.getpass.md)
40-
* [os.getversion](os.getversion.md)
41-
* [os.host](os.host.md)
42-
* [os.hostarch](os.hostarch.md)
43-
* [os.is](os.is.md)
44-
* [os.is64bit](os.is64bit.md)
45-
* [os.isdir](os.isdir.md)
46-
* [os.isfile](os.isfile.md)
47-
* [os.islink](os.islink.md)
48-
* [os.locate](os.locate.md)
49-
* [os.matchdirs](os.matchdirs.md)
50-
* [os.matchfiles](os.matchfiles.md)
51-
* [os.mkdir](os.mkdir.md)
52-
* [os.outputof](os.outputof.md)
53-
* [os.pathsearch](os.pathsearch.md)
54-
* [os.realpath](os.realpath.md)
55-
* [os.remove](os.remove.md)
56-
* [os.rmdir](os.rmdir.md)
57-
* [os.stat](os.stat.md)
58-
* [os.target](os.target.md)
59-
* [os.touchfile](os.touchfile.md)
60-
* [os.translateCommands](os.translateCommands.md)
61-
* [os.uuid](os.uuid.md)
62-
* [os.writefile_ifnotequal](os.writefile_ifnotequal.md)
30+
* [os.chdir](os/os.chdir.md)
31+
* [os.chmod](os/os.chmod.md)
32+
* [os.comparefiles](os/os.comparefiles.md)
33+
* [os.copyfile](os/os.copyfile.md)
34+
* [os.executef](os/os.executef.md)
35+
* [os.findheader](os/os.findheader.md)
36+
* [os.findlib](os/os.findlib.md)
37+
* [os.get](os/os.get.md)
38+
* [os.getcwd](os/os.getcwd.md)
39+
* [os.getpass](os/os.getpass.md)
40+
* [os.getversion](os/os.getversion.md)
41+
* [os.host](os/os.host.md)
42+
* [os.hostarch](os/os.hostarch.md)
43+
* [os.is](os/os.is.md)
44+
* [os.is64bit](os/os.is64bit.md)
45+
* [os.isdir](os/os.isdir.md)
46+
* [os.isfile](os/os.isfile.md)
47+
* [os.islink](os/os.islink.md)
48+
* [os.locate](os/os.locate.md)
49+
* [os.matchdirs](os/os.matchdirs.md)
50+
* [os.matchfiles](os/os.matchfiles.md)
51+
* [os.mkdir](os/os.mkdir.md)
52+
* [os.outputof](os/os.outputof.md)
53+
* [os.pathsearch](os/os.pathsearch.md)
54+
* [os.realpath](os/os.realpath.md)
55+
* [os.remove](os/os.remove.md)
56+
* [os.rmdir](os/os.rmdir.md)
57+
* [os.stat](os/os.stat.md)
58+
* [os.target](os/os.target.md)
59+
* [os.touchfile](os/os.touchfile.md)
60+
* [os.translateCommands](os/os.translateCommands.md)
61+
* [os.uuid](os/os.uuid.md)
62+
* [os.writefile_ifnotequal](os/os.writefile_ifnotequal.md)
6363

6464
### Path
6565

66-
* [path.appendExtension](path.appendExtension.md)
67-
* [path.getabsolute](path.getabsolute.md)
68-
* [path.getbasename](path.getbasename.md)
69-
* [path.getdirectory](path.getdirectory.md)
70-
* [path.getdrive](path.getdrive.md)
71-
* [path.getextension](path.getextension.md)
72-
* [path.getname](path.getname.md)
73-
* [path.getrelative](path.getrelative.md)
74-
* [path.hasextension](path.hasextension.md)
75-
* [path.isabsolute](path.isabsolute.md)
76-
* [path.iscfile](path.iscfile.md)
77-
* [path.iscppfile](path.iscppfile.md)
78-
* [path.iscppheader](path.iscppheader.md)
79-
* [path.isframework](path.isframework.md)
80-
* [path.islinkable](path.islinkable.md)
81-
* [path.isobjectfile](path.isobjectfile.md)
82-
* [path.isresourcefile](path.isresourcefile.md)
83-
* [path.join](path.join.md)
84-
* [path.normalize](path.normalize.md)
85-
* [path.rebase](path.rebase.md)
86-
* [path.replaceextension](path.replaceextension.md)
87-
* [path.translate](path.translate.md)
88-
* [path.wildcards](path.wildcards.md)
66+
* [path.appendExtension](path/path.appendExtension.md)
67+
* [path.getabsolute](path/path.getabsolute.md)
68+
* [path.getbasename](path/path.getbasename.md)
69+
* [path.getdirectory](path/path.getdirectory.md)
70+
* [path.getdrive](path/path.getdrive.md)
71+
* [path.getextension](path/path.getextension.md)
72+
* [path.getname](path/path.getname.md)
73+
* [path.getrelative](path/path.getrelative.md)
74+
* [path.hasextension](path/path.hasextension.md)
75+
* [path.isabsolute](path/path.isabsolute.md)
76+
* [path.iscfile](path/path.iscfile.md)
77+
* [path.iscppfile](path/path.iscppfile.md)
78+
* [path.iscppheader](path/path.iscppheader.md)
79+
* [path.isframework](path/path.isframework.md)
80+
* [path.islinkable](path/path.islinkable.md)
81+
* [path.isobjectfile](path/path.isobjectfile.md)
82+
* [path.isresourcefile](path/path.isresourcefile.md)
83+
* [path.join](path/path.join.md)
84+
* [path.normalize](path/path.normalize.md)
85+
* [path.rebase](path/path.rebase.md)
86+
* [path.replaceextension](path/path.replaceextension.md)
87+
* [path.translate](path/path.translate.md)
88+
* [path.wildcards](path/path.wildcards.md)
8989

9090
### String
9191

92-
* [string.capitalized](string.capitalized.md)
93-
* [string.contains](string.contains.md)
94-
* [string.endswith](string.endswith.md)
95-
* [string.escapepattern](string.escapepattern.md)
96-
* [string.explode](string.explode.md)
97-
* [string.findlast](string.findlast.md)
98-
* [string.hash](string.hash.md)
99-
* [string.lines](string.lines.md)
100-
* [string.plural](string.plural.md)
101-
* [string.sha1](string.sha1.md)
102-
* [string.startswith](string.startswith.md)
92+
* [string.capitalized](string/string.capitalized.md)
93+
* [string.contains](string/string.contains.md)
94+
* [string.endswith](string/string.endswith.md)
95+
* [string.escapepattern](string/string.escapepattern.md)
96+
* [string.explode](string/string.explode.md)
97+
* [string.findlast](string/string.findlast.md)
98+
* [string.hash](string/string.hash.md)
99+
* [string.lines](string/string.lines.md)
100+
* [string.plural](string/string.plural.md)
101+
* [string.sha1](string/string.sha1.md)
102+
* [string.startswith](string/string.startswith.md)
103103

104104
### Table
105105

106-
* [table.arraycopy](table.arraycopy.md)
107-
* [table.contains](table.contains.md)
108-
* [table.deepcopy](table.deepcopy.md)
109-
* [table.extract](table.extract.md)
110-
* [table.filterempty](table.filterempty.md)
111-
* [table.flatten](table.flatten.md)
112-
* [table.fold](table.fold.md)
113-
* [table.foreachi](table.foreachi.md)
114-
* [table.implode](table.implode.md)
115-
* [table.indexof](table.indexof.md)
116-
* [table.insertafter](table.insertafter.md)
117-
* [table.insertflat](table.insertflat.md)
118-
* [table.isempty](table.isempty.md)
119-
* [table.join](table.join.md)
120-
* [table.keys](table.keys.md)
121-
* [table.merge](table.merge.md)
122-
* [table.replace](table.replace.md)
123-
* [table.tostring](table.tostring.md)
124-
* [table.translate](table.translate.md)
106+
* [table.arraycopy](table/table.arraycopy.md)
107+
* [table.contains](table/table.contains.md)
108+
* [table.deepcopy](table/table.deepcopy.md)
109+
* [table.extract](table/table.extract.md)
110+
* [table.filterempty](table/table.filterempty.md)
111+
* [table.flatten](table/table.flatten.md)
112+
* [table.fold](table/table.fold.md)
113+
* [table.foreachi](table/table.foreachi.md)
114+
* [table.implode](table/table.implode.md)
115+
* [table.indexof](table/table.indexof.md)
116+
* [table.insertafter](table/table.insertafter.md)
117+
* [table.insertflat](table/table.insertflat.md)
118+
* [table.isempty](table/table.isempty.md)
119+
* [table.join](table/table.join.md)
120+
* [table.keys](table/table.keys.md)
121+
* [table.merge](table/table.merge.md)
122+
* [table.replace](table/table.replace.md)
123+
* [table.tostring](table/table.tostring.md)
124+
* [table.translate](table/table.translate.md)
125125

126126
### Term
127127

128-
* [term.getTextColor](term.getTextColor.md)
129-
* [term.setTextColor](term.setTextColor.md)
130-
* [term.pushColor](term.pushColor.md)
131-
* [term.popColor](term.popColor.md)
132-
* [term.clearToEndOfLine](term.clearToEndOfLine.md)
133-
* [term.moveLeft](term.moveLeft.md)
128+
* [term.getTextColor](term/term.getTextColor.md)
129+
* [term.setTextColor](term/term.setTextColor.md)
130+
* [term.pushColor](term/term.pushColor.md)
131+
* [term.popColor](term/term.popColor.md)
132+
* [term.clearToEndOfLine](term/term.clearToEndOfLine.md)
133+
* [term.moveLeft](term/term.moveLeft.md)
134134

135135
### Zip
136136

137-
* [zip.extract](zip.extract.md)
137+
* [zip.extract](zip/zip.extract.md)
138138

‎website/docs/Overrides-and-Call-Arrays.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ end)
7171

7272
This snippet replaces the original implementation of `m.project()` with my new (anonymous) function. From this point on, when someone calls `m.project()`, Premake will call my new function, passing it the original implementation as the first argument (`base`). If the function requires any other arguments (in this case, it receives the project being exported as `prj`) they appear after.
7373

74-
In our replacement function, we emit our comment header using `premake.w()`, which is short for "premake write", and [_PREMAKE_VERSION](premake_PREMAKE_VERSION.md), which is a global variable holding the version of the currently running Premake executable.
74+
In our replacement function, we emit our comment header using `premake.w()`, which is short for "premake write", and [_PREMAKE_VERSION](globals/premake_PREMAKE_VERSION.md), which is a global variable holding the version of the currently running Premake executable.
7575

7676
After emitting the comment we call `base(prj)`, the original implementation of `m.project()`, to do the rest of the work for us. Easy!
7777

‎website/docs/Project-API.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
| API | Brief |
44
|-----------------------------------------------------------|--------------------|
5-
| [_ACTION](premake_ACTION.md) | The action that will be run |
6-
| [_ARGS](premake_ARGS.md) | Array of action args |
7-
| [_MAIN_SCRIPT](premake_MAIN_SCRIPT.md) | |
8-
| [_MAIN_SCRIPT_DIR](premake_MAIN_SCRIPT_DIR.md) | |
9-
| [_OPTIONS](premake_OPTIONS.md) | |
10-
| [_OS](premake_OS.md) | The currently targeted operating system |
11-
| [_PREMAKE_COMMAND](premake_PREMAKE_COMMAND.md) | |
12-
| [_PREMAKE_DIR](premake_PREMAKE_DIR.md) | |
13-
| [_PREMAKE_VERSION](premake_PREMAKE_VERSION.md) | The version of the currently executing instance of Premake |
14-
| [_WORKING_DIR](premake_WORKING_DIR.md) | |
5+
| [_ACTION](globals/premake_ACTION.md) | The action that will be run |
6+
| [_ARGS](globals/premake_ARGS.md) | Array of action args |
7+
| [_MAIN_SCRIPT](globals/premake_MAIN_SCRIPT.md) | |
8+
| [_MAIN_SCRIPT_DIR](globals/premake_MAIN_SCRIPT_DIR.md) | |
9+
| [_OPTIONS](globals/premake_OPTIONS.md) | |
10+
| [_OS](globals/premake_OS.md) | The currently targeted operating system |
11+
| [_PREMAKE_COMMAND](globals/premake_PREMAKE_COMMAND.md) | |
12+
| [_PREMAKE_DIR](globals/premake_PREMAKE_DIR.md) | |
13+
| [_PREMAKE_VERSION](globals/premake_PREMAKE_VERSION.md) | The version of the currently executing instance of Premake |
14+
| [_WORKING_DIR](globals/premake_WORKING_DIR.md) | |
1515
| [architecture](architecture.md) | |
1616
| [atl](atl.md) | Use Microsoft's Active Template Library |
1717
| [basedir](basedir.md) | |
@@ -107,10 +107,10 @@
107107
| [implibname](implibname.md) | |
108108
| [implibprefix](implibprefix.md) | |
109109
| [implibsuffix](implibsuffix.md) | |
110-
| [include](include.md) | |
110+
| [include](globals/include.md) | |
111111
| [includedirs](includedirs.md) | |
112112
| [includedirsafter](includedirsafter.md) | |
113-
| [includeexternal](includeexternal.md) | |
113+
| [includeexternal](globals/includeexternal.md) | |
114114
| [inlining](inlining.md) | Tells the compiler when it should inline functions |
115115
| [intrinsics](intrinsics.md) | |
116116
| [kind](kind.md) | |

‎website/docs/Tokens.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ You can use command tokens anywhere you specify a command line, including:
8787

8888
* [buildcommands](buildcommands.md)
8989
* [cleancommands](cleancommands.md)
90-
* [os.execute](os.execute.md)
91-
* [os.executef](os.executef.md)
90+
* [os.execute](os/os.execute.md)
91+
* [os.executef](os/os.executef.md)
9292
* [postbuildcommands](postbuildcommands.md)
9393
* [prebuildcommands](prebuildcommands.md)
9494
* [prelinkcommands](prelinkcommands.md)

‎website/docs/Using-Modules.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ If you wish to make a module always available to *all* of your projects, you may
3737

3838
## Version Requirements
3939

40-
To ensure compatibility with your project script, it can sometimes be helpful to require a minimum version or range of versions for your module dependencies. Premake includes [a modified version Lua's `require()` function](require.md) which accepts a version test as its second argument.
40+
To ensure compatibility with your project script, it can sometimes be helpful to require a minimum version or range of versions for your module dependencies. Premake includes [a modified version Lua's `require()` function](globals/require.md) which accepts a version test as its second argument.
4141

4242
```lua
4343
require("qt", ">=1.1")
4444
```
4545

46-
See [the `require()` documentation](require.md) for more information and examples.
46+
See [the `require()` documentation](globals/require.md) for more information and examples.

‎website/docs/Whats-New-in-5.0.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ title: What's New in 5.0
2626
* [Removes](Removing-Values.md)
2727
* [System Scripts](System-Scripts.md)
2828
* [Tokens](Tokens.md)
29-
* [HTTP support](http.download.md)
29+
* [HTTP support](http/http.download.md)
3030

3131
## New or Modified Globals ##
3232

33-
* [_MAIN_SCRIPT](premake_MAIN_SCRIPT.md)
34-
* [_MAIN_SCRIPT_DIR](premake_MAIN_SCRIPT_DIR.md)
35-
* [_PREMAKE_DIR](premake_PREMAKE_DIR.md)
33+
* [_MAIN_SCRIPT](globals/premake_MAIN_SCRIPT.md)
34+
* [_MAIN_SCRIPT_DIR](globals/premake_MAIN_SCRIPT_DIR.md)
35+
* [_PREMAKE_DIR](globals/premake_PREMAKE_DIR.md)
3636

3737
## New or Modified API calls ##
3838

@@ -127,22 +127,22 @@ title: What's New in 5.0
127127

128128
## New or Modified Lua library calls ##
129129

130-
* [includeexternal](includeexternal.md) (new)
131-
* [require](require.md) (modified)
130+
* [includeexternal](globals/includeexternal.md) (new)
131+
* [require](globals/require.md) (modified)
132132

133133
* [debug.prompt](debug.prompt.md) (new)
134134

135-
* [http.download](http.download.md) (new)
136-
* [http.get](http.get.md) (new)
135+
* [http.download](http/http.download.md) (new)
136+
* [http.get](http/http.get.md) (new)
137137

138-
* [os.chmod](os.chmod.md) (new)
139-
* [os.islink](os.islink.md) (new)
140-
* [os.realpath](os.realpath.md) (new)
141-
* [os.uuid](os.uuid.md) (can now generated deterministic name-based UUIDs)
138+
* [os.chmod](os/os.chmod.md) (new)
139+
* [os.islink](os/os.islink.md) (new)
140+
* [os.realpath](os/os.realpath.md) (new)
141+
* [os.uuid](os/os.uuid.md) (can now generated deterministic name-based UUIDs)
142142

143-
* [path.getabsolute](path.getabsolute.md) (new "relative to" argument)
143+
* [path.getabsolute](path/path.getabsolute.md) (new "relative to" argument)
144144

145-
* [string.hash](string.hash.md) (new)
145+
* [string.hash](string/string.hash.md) (new)
146146

147147
## Deprecated Values and Functions ##
148148

‎website/docs/filter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Any settings that appear after this function in the script will be applied only
1212

1313
Each keyword must include a prefix to specify which field should be tested. The following field prefixes are currently supported:
1414

15-
* [action](premake_ACTION.md)
15+
* [action](globals/premake_ACTION.md)
1616
* [architecture](architecture.md)
1717
* [configurations](configurations.md)
1818
* [files](files.md)
1919
* [kind](kind.md)
2020
* [language](language.md)
21-
* [options](premake_OPTIONS.md)
21+
* [options](globals/premake_OPTIONS.md)
2222
* [platforms](platforms.md)
2323
* [system](system.md)
2424
* [toolset](toolset.md)

‎website/docs/dofileopt.md renamed to ‎website/docs/globals/dofileopt.md

File renamed without changes.

‎website/docs/iif.md renamed to ‎website/docs/globals/iif.md

File renamed without changes.

‎website/docs/include.md renamed to ‎website/docs/globals/include.md

File renamed without changes.

‎website/docs/includeexternal.md renamed to ‎website/docs/globals/includeexternal.md

File renamed without changes.

‎website/docs/premake_ACTION.md renamed to ‎website/docs/globals/premake_ACTION.md

File renamed without changes.

‎website/docs/premake_ARGS.md renamed to ‎website/docs/globals/premake_ARGS.md

File renamed without changes.

‎website/docs/premake_MAIN_SCRIPT.md renamed to ‎website/docs/globals/premake_MAIN_SCRIPT.md

File renamed without changes.

‎website/docs/premake_MAIN_SCRIPT_DIR.md renamed to ‎website/docs/globals/premake_MAIN_SCRIPT_DIR.md

File renamed without changes.

‎website/docs/premake_OPTIONS.md renamed to ‎website/docs/globals/premake_OPTIONS.md

File renamed without changes.

‎website/docs/premake_OS.md renamed to ‎website/docs/globals/premake_OS.md

File renamed without changes.

‎website/docs/premake_PREMAKE_COMMAND.md renamed to ‎website/docs/globals/premake_PREMAKE_COMMAND.md

File renamed without changes.

‎website/docs/premake_PREMAKE_DIR.md renamed to ‎website/docs/globals/premake_PREMAKE_DIR.md

File renamed without changes.

‎website/docs/premake_PREMAKE_VERSION.md renamed to ‎website/docs/globals/premake_PREMAKE_VERSION.md

File renamed without changes.

0 commit comments

Comments
 (0)