steveburnett commented on code in PR #10793:
URL:
https://github.com/apache/incubator-gluten/pull/10793#discussion_r2388332424
##########
docs/developers/NewToGluten.md:
##########
@@ -306,34 +187,34 @@ Set config in `settings.json`
"editor.formatOnSave": true,
```
-If exists multiple clang-format version, formatOnSave may not take effect,
specify the default formatter
-Search `default formatter` in `Settings`, select Clang-Format.
+If multiple clang-format versions are installed, `formatOnSave` may not take
effect. To specify the default formatter,
+search for `default formatter` in **Settings**, then select **Clang-Format**.
-If your formatOnSave still make no effect, you can use shortcut `SHIFT+ALT+F`
to format one file manually.
+If `formatOnSave` still has no effect, select a single file and use
`SHIFT+ALT+F` to format it manually.
-### CMake format
+#### CMake format
-To format cmake files, like CMakeLists.txt & *.cmake, please install
`cmake-format`.
+To format cmake files like `CMakeLists.txt` & `*.cmake`, install
`cmake-format`.
Review Comment:
```suggestion
To format cmake files like `CMakeLists.txt` and `*.cmake`, install
`cmake-format`.
```
##########
docs/developers/NewToGluten.md:
##########
@@ -183,115 +154,25 @@ configurations below:
}
```
-After compiling with these updated configs, you should have executable files
(such as
-`<gluten_home>/cpp/build/velox/tests/velox_shuffle_writer_test`).
-
-Open the `Run and Debug` panel (Ctrl-Shift-D) and then click the link to
create a launch.json file. If prompted,
-select a debugger like "C++ (GDB/LLDB)". The launch.json will be created at:
`<gluten_home>/.vscode/launch.json`.
-
-Click the `Add Configuration` button in launch.json, and select gdb "launch"
(to start and debug a program) or
-"attach" (to attach and debug a running program).
-
-#### launch.json example
-
-```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
- "version": "0.2.0",
- "configurations": [
- {
- "name": "velox shuffle writer test",
- "type": "cppdbg",
- "request": "launch",
- "program":
"${workspaceFolder}/cpp/build/velox/tests/velox_shuffle_writer_test",
- "args": ["--gtest_filter='*SinglePartitioningShuffleWriter*'"],
- "stopAtEntry": false,
- "cwd": "${fileDirname}",
- "environment": [],
- "externalConsole": false,
- "MIMode": "gdb",
- "setupCommands": [
- {
- "description": "Enable pretty-printing for gdb",
- "text": "-enable-pretty-printing",
- "ignoreFailures": true
- },
- {
- "description": "Set Disassembly Flavor to Intel",
- "text": "-gdb-set disassembly-flavor intel",
- "ignoreFailures": true
- }
- ]
- },
- {
- "name": "benchmark test",
- "type": "cppdbg",
- "request": "launch",
- "program":
"${workspaceFolder}/cpp/build/velox/benchmarks/./generic_benchmark",
- "args": [
- "--threads=1",
- "--with-shuffle",
- "--partitioning=hash",
- "--iterations=1",
-
"--conf=${workspaceFolder}/backends-velox/generated-native-benchmark/conf_12_0_2.ini",
-
"--plan=${workspaceFolder}/backends-velox/generated-native-benchmark/plan_12_0_2.json",
-
"--data=${workspaceFolder}/backends-velox/generated-native-benchmark/data_12_0_2_0.parquet,${workspaceFolder}/backends-velox/generated-native-benchmark/data_12_0_2_1.parquet"
- ],
- "stopAtEntry": false,
- "cwd": "${fileDirname}",
- "environment": [],
- "externalConsole": false,
- "MIMode": "gdb",
- "setupCommands": [
- {
- "description": "Enable pretty-printing for gdb",
- "text": "-enable-pretty-printing",
- "ignoreFailures": true
- },
- {
- "description": "Set Disassembly Flavor to Intel",
- "text": "-gdb-set disassembly-flavor intel",
- "ignoreFailures": true
- }
- ]
- }
-
- ]
-}
-```
-
-> Change `name`, `program`, `args` for your environment. For example, your
generated benchmark example file names may vary.
+After compiling with these updated configs, you should have executable files,
such as
+`<gluten_home>/cpp/build/velox/tests/velox_shuffle_writer_test`.
-Then you can create breakpoint and debug in `Run and Debug` section.
+Open the **Run and Debug** panel (Ctrl-Shift-D) and then click the link to
create a `launch.json` file. If prompted,
+select a debugger like "C++ (GDB/LLDB)". The `launch.json` will be created
under `<gluten_home>/.vscode/` (see example [here](../resources/launch.json)).
Review Comment:
```suggestion
select a debugger like **C++ (GDB/LLDB)**. The `launch.json` will be
created under `<gluten_home>/.vscode/`.
```
Format nit for **C++ (GDB/LLDB)**, and deleting the text linking to the
now-deleted example file.
##########
docs/developers/NewToGluten.md:
##########
@@ -329,11 +205,11 @@ After the above installation, you can optionally do some
configuration in Visual
* Set Args: `--first-comment-is-literal=True`.
Review Comment:
```suggestion
* Set **Args**: `--first-comment-is-literal=True`.
```
Let me know if this is not user-visible, like **Exe Path** in line 211.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
