Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update comments to better indicate the supported VT functions #4752

Merged
1 commit merged into from
Mar 17, 2020

Conversation

j4james
Copy link
Collaborator

@j4james j4james commented Feb 29, 2020

Summary of the Pull Request

Most of the methods in the ITermDispatch interface have a comment following them that indicates the VT function that they implement. These comments are then used by the script in PR #1884 to generate a table of supported VT functions. This PR updates some of those comments, to more accurately reflect the functions that are actually supported.

References

PR #1884

PR Checklist

  • Closes #xxx
  • CLA signed.
  • No new tests.
  • No new docs.
  • I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: initial draft of VT function support spec #1884

Detailed Description of the Pull Request / Additional comments

In some cases there are methods that implement multiple VT functions which are essentially aliases. Originally the comments listed only one of the functions, so I've now updated them to list both. This includes HPA as an alias of CHA, and HVP as an alias of CUP.

Similarly, some control characters are implemented in terms of another VT function, but only the main function was listed in the comment. Again I've now updated the comments to list both the main function and any related control characters. This includes BS (sharing the same method as CUB), HT (the same method as CHT), and LF, FF, and VT (the same method as IND and NEL).

Then there were some minor corrections. The DeviceAttributes method was commented as DA, but it really should be DA1. DesignateCharset was simply commented as DesignateCharset, when it should be SCS. The DECSCNM comment was missing a space, so it wasn't picked up by the script. And the SetColumns comment mistakenly included DECSCPP, but we don't actually support that.

Finally there is the DeviceStatusReport method, which potentially covers a wide range of different reports. But for now we only support the Cursor Position Report, so I've commented it as DSR, DSR-CPR to more clearly indicate our level of support. In the long term we'll probably need a better way of handling these reports though.

Validation Steps Performed

I've run the script from PR #1884 and confirmed that the output is now a more accurate reflection of our actual VT support.

@zadjii-msft zadjii-msft added the Area-VT Virtual Terminal sequence support label Mar 10, 2020
Copy link
Member

@zadjii-msft zadjii-msft left a comment

Choose a reason for hiding this comment

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

Thanks for your diligence 😄

@zadjii-msft zadjii-msft added Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Needs-Second It's a PR that needs another sign-off labels Mar 10, 2020
@oising
Copy link
Collaborator

oising commented Mar 11, 2020

Thank you @j4james James

Copy link
Member

@miniksa miniksa left a comment

Choose a reason for hiding this comment

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

Thank you!

@miniksa miniksa added AutoMerge Marked for automatic merge by the bot when requirements are met and removed Needs-Second It's a PR that needs another sign-off labels Mar 17, 2020
@ghost
Copy link

ghost commented Mar 17, 2020

Hello @miniksa!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit 8a9475a into microsoft:master Mar 17, 2020
@j4james j4james deleted the improve-vt-comments branch March 23, 2020 22:28
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-VT Virtual Terminal sequence support AutoMerge Marked for automatic merge by the bot when requirements are met Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants