-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move Documentation from wiki to main repo
- Loading branch information
1 parent
0efd3ef
commit 62a0865
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Pipe Transport | ||
Pipe Transport allows communication through a pipe program to a remote shell. An example on linux would be `ssh`. | ||
|
||
## How-To | ||
We have added `"pipeTransport"` as an option within the `launch.json` file. The structure looks as follows: | ||
``` | ||
"pipeTransport": { | ||
"pipeCwd": "/usr/bin", | ||
"pipeProgram": "/usr/bin/ssh", | ||
"pipeArgs": [ | ||
"-pw", | ||
"<password>", | ||
"[email protected]" | ||
], | ||
"debuggerPath": "/usr/bin/gdb" | ||
}, | ||
``` | ||
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. | ||
|
||
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: | ||
``` | ||
"sourceFileMap": { | ||
// "remote": "local" | ||
"/home/user/src": "/src/projectA/src" | ||
} | ||
``` | ||
|
||
## Attach | ||
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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,6 @@ This repo is the official repository for filing issues against and getting suppo | |
|
||
### Microsoft Open Source Code of Conduct | ||
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. | ||
|
||
### Documentation | ||
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. |