Skip to content

Remove avoidable VS Code references - #142

Merged
jreineckearm merged 4 commits into
eclipse-cdt-cloud:mainfrom
jreineckearm:vscode-reference-feedback
Jul 21, 2026
Merged

Remove avoidable VS Code references#142
jreineckearm merged 4 commits into
eclipse-cdt-cloud:mainfrom
jreineckearm:vscode-reference-feedback

Conversation

@jreineckearm

Copy link
Copy Markdown
Contributor

Removed avoidable VS Code references.
See discussion on original PR #138 .

@jreineckearm

Copy link
Copy Markdown
Contributor Author

@GitMensch , please see this PR to follow up on #138. Created a new one to avoid forking from your fork.
@jonahgraham , please also review if you are happy with the changed extension description.

@GitMensch GitMensch left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general

Comment thread package.json Outdated
@GitMensch

Copy link
Copy Markdown

@jreineckearm What is the status of this PR?

@jreineckearm

Copy link
Copy Markdown
Contributor Author

Thanks for the reminder, @GitMensch . Slipped off the radar.... 😕
Will rebase and review if new references slipped in.

Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
@jreineckearm
jreineckearm force-pushed the vscode-reference-feedback branch from 8aa6b0f to 0c41ce2 Compare July 20, 2026 15:13
@jreineckearm
jreineckearm requested review from cwalther and omarArm July 20, 2026 15:26
@cwalther

Copy link
Copy Markdown
Contributor

I agree that there are some references that are unnecessary and can be removed, but I find it rather confusing that the README now only calls this an “extension” but never specifies what it extends. One can only guess it from the project name. I think there should be at least one mention of Visual Studio Code somewhere near the beginning, e.g.

This is an extension that supports debugging using GDB and the MI protocol in Visual Studio Code and compatible IDEs.

or

This is an extension for Visual Studio Code and compatible IDEs that supports debugging using GDB and the MI protocol.

That seems consistent with Microsoft’s brand guidelines.

Other than that, I have no strong opinions.

@GitMensch

Copy link
Copy Markdown

I agree with @cwalther (I think my original PR used "vscode" in at least one place).

I'd have to check, but the DAP part may even be usable without vscode - for example in emacs/vim? Then "Debug Adapter Protocol" may be used in some place as well.

@jreineckearm

Copy link
Copy Markdown
Contributor Author

I like the wording "Visual Studio Code and compatible IDEs". I'll add that to the first paragraph of the readme tomorrow.
I'll also extend the changed description by "....with GDB into VS Code and compatible IDEs". That should mitigate your original concerns of mistaking this for a Visual Studio extension (not a VS Code extension).

Yes, the original PR used "vscode". But TBF: I'd stay with "VS Code" and similar. At the end of the day we are shipping a VSIX (Visual Studio Extension). So, I am not convinced there is a lot of benefit in introducing subtle differences like saying "vscode". It may rather confuse users who are not that familiar with all these details.

@jreineckearm
jreineckearm force-pushed the vscode-reference-feedback branch from 6c37540 to 6fea5cf Compare July 21, 2026 06:46

@cwalther cwalther left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not to mention that “vscode” is against the guidelines (“Note proper capitalization and spacing”).


You new commit 0083972 turned out empty, was that intentional? Seems like a regression (6c37540 was good).

Comment thread CONTRIBUTING.md Outdated
@jreineckearm

jreineckearm commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Text should be fixed. I am planning to squash on merge, hence won't bother with fixing the commit history now.

@cwalther

Copy link
Copy Markdown
Contributor

👍 on that. I am still missing the change from 6c37540 that I think was good, regardless of commit history. (Or an explanation that you removed it intentionally.)

@GitMensch

Copy link
Copy Markdown

Not to mention that “vscode” is against the guidelines (“Note proper capitalization and spacing”).

The point is exactly that "VS Code" = "Visual Studio Code" ==> the Microsoft product (= software + customizations, partially closed source, often not under a free license), while "vscode" is the MIT licensed software (where people can build free versions from and which the community sends PRs against as well). Extensions are written to the software, not the specific product.

There is also software - like Theia, which are not based on vscode, but provide a vscode compatible extension interface.

--> Visual Studio Code (which possibly should be best referred to with including Microsoft as it is their product under their license).

/rant off

Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
@jreineckearm
jreineckearm force-pushed the vscode-reference-feedback branch from f2a2ad2 to 9ecc3e2 Compare July 21, 2026 08:15
@jreineckearm

jreineckearm commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

@cwalther , must have screwed up that commit while squashing things initially. Now squashed all changes since yesterday into one commit to move on.

@GitMensch , I get where you are coming from. But even Theia, which is probably the closest to this project, uses Microsoft terminology, not vscode. See

Will follow that example to keep consistency.

@cwalther

Copy link
Copy Markdown
Contributor

@jreineckearm, my last comment still stands – I think you missed one commit in your squashing. Please

  • either reinstate the change from 6c37540 (merge 9ecc3e2 and 6c37540 or rebase one onto the other or equivalent)
  • or state that you removed that change deliberately.

Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
@jreineckearm

Copy link
Copy Markdown
Contributor Author

Change reinstated as 94ae385

@jreineckearm
jreineckearm merged commit 0bf7e03 into eclipse-cdt-cloud:main Jul 21, 2026
5 checks passed
@jreineckearm
jreineckearm deleted the vscode-reference-feedback branch July 29, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants