vieter-v
/
v
2
0
Fork 0
Code Issues Pull Requests Releases Activity

docs,ci: fix too long lines

pull/10347/head
Delyan Angelov 2021-06-04 18:17:34 +03:00
parent 5266b4921d
commit 117295e1f3
No known key found for this signature in database
GPG Key ID: 66886C0F12D595ED
2 changed files with 31 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/docs.md
View File

@ -3874,11 +3874,13 @@ Troubleshooting (debugging) executables [created with V in GDB](https://github.c
### Native Backend binaries
Currently there is no debugging support for binaries created by the native backend (flag: `-b native`).
Currently there is no debugging support for binaries, created by the
native backend (flag: `-b native`).
### Javascript Backend
There is currently no support for source maps for Javascript output create by the JS Backend (flag: `-b js`).
There is currently no support for source maps for Javascript output,
created by the JS Backend (flag: `-b js`).

40
doc/vscode.md
View File

@ -7,7 +7,8 @@
## V language support
The [V VS Code Extention](https://marketplace.visualstudio.com/items?itemName=vlanguage.vscode-vlang) provides V language support for Visual Studio Code.
The [V VS Code Extention](https://marketplace.visualstudio.com/items?itemName=vlanguage.vscode-vlang)
provides V language support for Visual Studio Code.
![Screenshot Code with activated extention](https://github.com/vlang/vscode-vlang/raw/HEAD/images/demo.png)
@ -18,7 +19,9 @@ The [V VS Code Extention](https://marketplace.visualstudio.com/items?itemName=vl
* Linter (Workspace files only).
[more](https://marketplace.visualstudio.com/items?itemName=vlanguage.vscode-vlang)
**Hint:** This extention will not add the V compiler! Information on how to [install V compiler](https://github.com/vlang/v/blob/master/doc/docs.md#install-from-source) on your operating system.
**Hint:** This extention will not add the V compiler! Information on how to
[install V compiler](https://github.com/vlang/v/blob/master/doc/docs.md#install-from-source)
on your operating system.
### Setup
@ -28,7 +31,8 @@ Install [V VS Code Extention](https://marketplace.visualstudio.com/items?itemNam
![screenshot visual debugger](https://github.com/vlang/v/blob/master/doc/img/vscode-debugger.png?raw=true)
The [C/C++ Extention](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) for Visual Studio Code provides visual conditional debugging.
The [C/C++ Extention](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
for Visual Studio Code provides visual conditional debugging.
**Features:**
* Conditional breakpoints
@ -37,7 +41,9 @@ The [C/C++ Extention](https://marketplace.visualstudio.com/items?itemName=ms-vsc
* Change Values
[more Features & Documentation](https://code.visualstudio.com/docs/cpp/cpp-debug)
**Hint:** Not all types (e.g. Array) in V currently create the required [DWARF](https://en.wikipedia.org/wiki/DWARF) information to show and edit the variable.
**Hint:** Not all types (e.g. Array) in V currently create the required
[DWARF](https://en.wikipedia.org/wiki/DWARF) information to show and
edit the variable.
### Setup
@ -46,21 +52,24 @@ The [C/C++ Extention](https://marketplace.visualstudio.com/items?itemName=ms-vsc
3. Click on `Show` all automatic debug configurations.
4. Select `Add config`.
5. Select environment `C++ (GDB/LLDB)`.
6. Change the line `"program": "Programmnamen eingeben, z. B. \"${workspaceFolder}/a.out\"",` to point to your compiled application e.g. `"program": "${workspaceFolder}/hello",`.
6. Change the line `"program": "Enter the program name, e.g. \"${workspaceFolder}/a.out\"",`
to point to your compiled application e.g. `"program": "${workspaceFolder}/hello",`.
This will add a block to your `.workspace` file or creates the file `.vscode/launch.json`:
This will add a block to your `.workspace` file,
or create the file `.vscode/launch.json`:
```json
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
// For more information, visit:
// https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "(lldb) Starten",
"name": "(lldb) Start",
"type": "cppdbg",
"request": "launch",
"program": "Programmnamen eingeben, z. B. \"${workspaceFolder}/a.out\"",
"program": "Enter the program name, e.g. \"${workspaceFolder}/a.out\"",
"args": [],
"stopAtEntry": false,
"cwd": "${fileDirname}",
@ -74,17 +83,22 @@ This will add a block to your `.workspace` file or creates the file `.vscode/lau
### Usage
To allow your compiled application to be debugged. The application needs to include additional debugging information ([DWARF](https://en.wikipedia.org/wiki/DWARF)).
To allow your compiled application to be debugged.
The application needs to include additional debugging information
([DWARF](https://en.wikipedia.org/wiki/DWARF)).
**1. Compile with debugging information:**
`v -b c -g hello.v -o hello` or short `v -g hello.v`
The `-g` option will add the needed debugging informations. More Options are explained in the [docs](docs.md#debugging).
The `-g` option will add the needed debugging informations.
More Options are explained in the [docs](docs.md#debugging).
**2. Start Debugging**
1. Open your source code and set the required break points
2. Click on the Debug Icon in the left Icon panel and klick `> (lldb) Start` or use `F5` to launch your application in debug mode.
2. Click on the Debug Icon in the left Icon panel and click
`> (lldb) Start`, or use `F5` to launch your application in debug mode.
For all options look at the official [C/C++ Extention documentation](https://code.visualstudio.com/docs/cpp/cpp-debug).
For all options look at the official
[C/C++ Extention documentation](https://code.visualstudio.com/docs/cpp/cpp-debug).