Skip to content

Commit 62a0865

Browse files
committed
Move Documentation from wiki to main repo
1 parent 0efd3ef commit 62a0865

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Pipe Transport
2+
Pipe Transport allows communication through a pipe program to a remote shell. An example on linux would be `ssh`.
3+
4+
## How-To
5+
We have added `"pipeTransport"` as an option within the `launch.json` file. The structure looks as follows:
6+
```
7+
"pipeTransport": {
8+
"pipeCwd": "/usr/bin",
9+
"pipeProgram": "/usr/bin/ssh",
10+
"pipeArgs": [
11+
"-pw",
12+
"<password>",
13+
14+
],
15+
"debuggerPath": "/usr/bin/gdb"
16+
},
17+
```
18+
The `pipeArgs` can be any set of arguments necessary to setup and authenticate the pipe connection. In the example, a password is used but you can also use an ssh key.
19+
20+
You may also need to add a `sourceFileMap` to map the path of where the code exists on the remote shell to where it is locally:
21+
```
22+
"sourceFileMap": {
23+
// "remote": "local"
24+
"/home/user/src": "/src/projectA/src"
25+
}
26+
```
27+
28+
## Attach
29+
You can also use the above `pipeTransport` block to attach to a remote process. In the attach case, you will need to specify a `processId`. We have added the ability to query processes from the remote machine. To do this, change `"processId": "${command.pickProcess}"` to `"processId": "${command.pickRemoteProcess}"`. The `pipeTransport` settings will be used to query the processes on the remote machine. Then select the process from the drop down list. As with `launch`, you may need to configure `sourceFileMap`.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@ This repo is the official repository for filing issues against and getting suppo
44

55
### Microsoft Open Source Code of Conduct
66
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
7+
8+
### Documentation
9+
Documentation has been moved to a folder marked Documentation within the repository. If you would like to contribute, please create markdown file and submit a pull request.

0 commit comments

Comments
 (0)