Skip to content

Update documentation for FASTLINK #4322

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

Merged
merged 3 commits into from
Dec 6, 2022

Conversation

gregg-miskelly
Copy link
Contributor

The documentation for FASTLINK had a few issues that this PR attempts to address:

  • The sentence about "executable is deployed on another computer" was confusing because deploying the executable isn't a problem if you are doing so to remote debug. The real problem is attempting to deploy the PDB.
  • The performance notes on FASTLINK were not correct for Visual Studio 2019 and later

The documentation for FASTLINK had a few issues that this PR attempts to address:
* The sentence about "executable is deployed on another computer" was confusing because deploying the executable isn't a problem if you are doing so to remote debug. The real problem is attempting to deploy the PDB.
* The performance notes on FASTLINK were not correct for Visual Studio 2019 and later
@prmerger-automator
Copy link
Contributor

@gregg-miskelly : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@gregg-miskelly
Copy link
Contributor Author

CC @RussKeldorph

@jborsecnik
Copy link
Contributor

@corob-msft,

Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, add a #sign-off comment to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@opbld30
Copy link

opbld30 commented Dec 2, 2022

Learn Build status updates of commit 2d370a7:

✅ Validation status: passed

File Status Preview URL Details
docs/build/reference/debug-generate-debug-info.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Make the grammar checker happy. 
Use consistent formatting of compiler options.
@prmerger-automator
Copy link
Contributor

@gregg-miskelly : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@opbld31
Copy link

opbld31 commented Dec 2, 2022

Learn Build status updates of commit 8c7fce3:

✅ Validation status: passed

File Status Preview URL Details
docs/build/reference/debug-generate-debug-info.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@colin-home
Copy link
Contributor

@gregg-miskelly @RussKeldorph
The sentence "You can't use this limited PDB to debug on computers other than the computer where the binary and its libs were built, as the PDB isn't intended to be used on any other computer" doesn't seem to imply that it's okay to deploy the binary for test on another computer, as long as the debugging is done remotely from the build computer. Could this be reworded to something like the following?

"You can only use this limited PDB to debug from the computer where the binary and its libraries were built. If you deploy the binary elsewhere, you may debug it remotely from the build computer, but not directly on the test computer."

@gregg-miskelly
Copy link
Contributor Author

Your sentence sounds fine to me. I will update the PR.

@prmerger-automator
Copy link
Contributor

@gregg-miskelly : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@opbld31
Copy link

opbld31 commented Dec 2, 2022

Learn Build status updates of commit 916ede5:

✅ Validation status: passed

File Status Preview URL Details
docs/build/reference/debug-generate-debug-info.md ✅Succeeded

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Copy link
Contributor

@colin-home colin-home left a comment

Choose a reason for hiding this comment

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

@gregg-miskelly @RussKeldorph I'm going to approve and merge this, and if you have any updates, we can make that another PR. Thanks for the contribution.

@colin-home colin-home merged commit 1a6021a into MicrosoftDocs:main Dec 6, 2022
@RussKeldorph
Copy link
Contributor

Thanks @gregg-miskelly and @corob-msft for taking care of this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants