Skip to content

Commit

Permalink
Add documentation for the new Linux apis
Browse files Browse the repository at this point in the history
  • Loading branch information
redorav committed Aug 14, 2023
1 parent b167162 commit b77085c
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 0 deletions.
23 changes: 23 additions & 0 deletions website/docs/remotedeploydir.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Directory on the remote machine where the project will be deployed to.

```lua
remoteprojectdir ("path")
```

### Parameters ###

`path` specifies the directory on the remote machine where the project is deployed

### Applies To ###

The `config` scope.

### Availability ###

Premake 5.0.0 alpha 14 or later, only applies to Visual Studio Linux projects.

### Examples ###

```lua
remoteprojectdir "$(RemoteProjectDir)"
```
23 changes: 23 additions & 0 deletions website/docs/remoteprojectdir.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Project directory as seen by the Windows Subsystem for Linux shell.

```lua
remoteprojectdir ("path")
```

### Parameters ###

`path` specifies the directory on the remote machine that WSL sees the project in

### Applies To ###

The `config` scope.

### Availability ###

Premake 5.0.0 alpha 14 or later, only applies to Visual Studio Linux projects.

### Examples ###

```lua
remoteprojectdir "$(RemoteRootDir)/$(ProjectName)"
```
23 changes: 23 additions & 0 deletions website/docs/remoteprojectreldir.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Specifies the subdirectory on the remote machine to copy each project's source code to.

```lua
remoteprojectreldir ("path")
```

### Parameters ###

`path` specifies the directory on the remote machine where the source files of a single project will be copied to before compiling, relative to the root path

### Applies To ###

The `config` scope.

### Availability ###

Premake 5.0.0 alpha 14 or later, only applies to Visual Studio Linux projects.

### Examples ###

```lua
remoteprojectreldir "%{prj.name}"
```
23 changes: 23 additions & 0 deletions website/docs/remoterootdir.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Specifies the base directory on the remote machine to deploy the source code to before compiling.

```lua
remoterootdir ("path")
```

### Parameters ###

`path` specifies the directory on the remote machine where the source files will be copied to before compiling

### Applies To ###

The `config` scope.

### Availability ###

Premake 5.0.0 alpha 14 or later, only applies to Visual Studio Linux projects.

### Examples ###

```lua
remoterootdir "~/projects/%{prj.name}"
```

0 comments on commit b77085c

Please sign in to comment.