cleanup vscode references #138
Conversation
|
@GitMensch , thanks for the PR! One of the reasons for the now used title is Microsoft's brand guidelines which we, I believe, should honor. Especially if publishing now to their Marketplace. https://code.visualstudio.com/brand#brand-name Let me add some comments on the particular changes themselves. |
| @@ -1,8 +1,8 @@ | |||
| # CDT GDB Debug Adapter Extension for Visual Studio Code | |||
| # CDT GDB Debug Adapter Extension for vscode | |||
There was a problem hiding this comment.
I believe this should remain "Visual Studio Code" (first time usage in this document).
There was a problem hiding this comment.
Possibly... note that by doing so, you use a Microsoft registered trademark (both the long and the short "VS Code" are) for something that is not directly invoked with that binary distribution. And of course when doing so the trademark's owner has something to say about how you may use it (all the icons and names stuff in your referenced doc is about that).
From the vscode repo's README:
Visual Studio Code is a distribution of the Code - OSS [vscode] repository with Microsoft-specific customizations released under a traditional Microsoft product license.
From their FAQ they link to microsoft/vscode#60 (comment) and make an extra point of https://code.visualstudio.com/docs/supporting/faq#_what-does-built-on-open-source-mean
In my view there are three options:
- go the full MS way using their trademark all over the place (I personally dislike doing that whenever the parts referenced have nothing to do with the trademark
- don't use that at all - because that README will mostly be shown in the editors themselves (extension view), then in the marketplaces - so you are "in" there already, no need to reference it (for GitHub and other places you can additionally talks about "for editors base on vscode including Visual Studio Code" (or however you like it) in the project's description (note, instead of the current "CDT GDB Visual Studio Code Extension" MS seems to want you to say "CDT GDB extension for Visual Studio Code", if you want to reference the trademark directly)
- use the name of the tool that all is based on, which is named "Code - OSS" (until it is re-branded, which is the case for nearly all binary distributions as well as in installations like GitPod) or "vscode"
|
|
||
| This is a Visual Studio Code extension that supports debugging using gdb and any other debugger that supports the MI protocol. It is built by the experts that provide the gdb support in the Eclipse C/C++ IDE (CDT). | ||
| This is an extension for vscode that supports debugging using gdb and any other debugger that supports the MI protocol. It is built by the experts that provide the gdb support in the Eclipse C/C++ IDE (CDT). |
There was a problem hiding this comment.
Should probably say VS Code instead.
There was a problem hiding this comment.
... if you want the trademark name there
|
|
||
| This extension provides a number of features that integrate into the Visual Studio Code debug environment. This includes launch types, support for the standard debug views as well as a custom viewer for memory browsing. | ||
| This extension provides a number of features that integrate into the vscode debug environment. This includes launch types, support for the standard debug views as well as a custom viewer for memory browsing. |
There was a problem hiding this comment.
Same as above: VS Code
| @@ -12,7 +12,7 @@ External tools are expected to be present on your system depending on the intend | |||
|
|
|||
| ## Launch Configurations | |||
|
|
|||
| The Visual Studio Debug Extension for GDB contributes two debugger types: | |||
| This extension contributes two debugger types: | |||
There was a problem hiding this comment.
👍 , ok. Probably overdid it here a little.
| @@ -105,7 +105,7 @@ Settings related to displaying UART output in the debug console. This object can | |||
|
|
|||
| ## Memory Browser | |||
|
|
|||
| The extension comes with a Memory Browser window. However, we have plans to deprecate and remove the window in favour of the Eclipse CDT Cloud [Memory Inspector](https://github.com/eclipse-cdt-cloud/vscode-memory-inspector) extension for Visual Studio Code which is available from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector) and the [Open VSX Registry](https://open-vsx.org/extension/eclipse-cdt/memory-inspector). | |||
| The extension comes with a Memory Browser window. However, we have plans to deprecate and remove the window in favour of the Eclipse CDT Cloud [Memory Inspector](https://github.com/eclipse-cdt-cloud/vscode-memory-inspector) extension for vscode which is available from the [Microsoft Marketplace](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector) and the [Open VSX Registry](https://open-vsx.org/extension/eclipse-cdt/memory-inspector). | |||
There was a problem hiding this comment.
Again, better VS Code.
I believe we should at least say VS Code Marketplace (with or without Microsoft). Microsoft has other marketplaces as well, e.g. https://azuremarketplace.microsoft.com/de-de/
There was a problem hiding this comment.
agreed, Microsoft talks about it as "Extension Marketplace" and "VS Code Marketplace"
|
Whatever way you choose (thinking about it, dropping the trademarks and names altogether apart from the VS Code Marketplace seems not so bad) - I think there are some general hints on this here. I think its faster if you do the changes you are ok with, instead of going back and forth in this PR. Feel free to close with the appropriate commit :-) |
|
Thanks for the feedback, @GitMensch ! |
|
closed in favor of #142 |
"Visual Studio Debug Extension" sounds like it is usable with "Visual Studio (IDE)", but that can be easily simplified.
In the other cases I've used "vscode" which is the free software behind the binary-only product "Microsoft Visual Studio Code". Nice side effect - it is more concise.