Lots of developers (myself included) uses Visual Studio Code as their primary
IDE for DPDK development. I have been successfully using various incarnations of
this script internally to quickly set up my development trees whenever I need a
new configuration, so this script is being shared in hopes that it will be
useful both to new developers starting with DPDK, and to seasoned DPDK
developers who are already or may want to start using Visual Studio Code. It
makes starting working on DPDK in Visual Studio Code so much easier!

** NOTE: While code analysis configuration is now populated from Meson and
   should pick up platform- or OS-specifc configuration, I have no way to test
   the code analysis configuration on anything but Linux/x86.

** NOTE 2: this is not for *Visual Studio* the Windows IDE, this is for *Visual
   Studio Code* the cross-platform code editor. Specifically, main target
   audience for this script is people who either run DPDK directly on their
   Linux machine, or who use Remote SSH functionality to connect to a remote
   Linux machine and set up VSCode build there. While the script should in 
theory
   work with any OS/platform supported by DPDK, it was not tested under anything
   but Linux/x86.

(if you're unaware of what is Remote SSH, I highly suggest checking it out [1])

Philosophy behind this script is as follows:

- Any build directory created will automatically add itself to VSCode
  configuration

- Launch configuration is created using `which gdb`, so by default non-root
  users will have to do additional system configuration for things to work. This
  is now documented in a new section called "Integration with IDE's".

- All of the interactive stuff has now been taken out and is planned to be
  included in a separate set of scripts, so this script now concerns itself only
  with adding build/launch targets to user's configuration and not much else

Please feel free to make any suggestions!

[1] https://code.visualstudio.com/docs/remote/ssh

Anatoly Burakov (1):
  buildtools: add VSCode configuration generator

 app/meson.build                             |  14 +-
 buildtools/gen-vscode-conf.py               | 570 ++++++++++++++++++++
 buildtools/meson.build                      |   5 +
 devtools/test-meson-builds.sh               |   3 +
 doc/guides/contributing/ide_integration.rst |  85 +++
 doc/guides/contributing/index.rst           |   1 +
 doc/guides/rel_notes/release_24_11.rst      |   5 +
 examples/meson.build                        |  15 +-
 meson.build                                 |  14 +
 9 files changed, 710 insertions(+), 2 deletions(-)
 create mode 100755 buildtools/gen-vscode-conf.py
 create mode 100644 doc/guides/contributing/ide_integration.rst

-- 
2.43.5

Reply via email to