Skip to content

Diagnostic Scripts + README changes#489

Merged
rajatarya merged 7 commits intomainfrom
rajat/diagnostic_scripts
Sep 11, 2025
Merged

Diagnostic Scripts + README changes#489
rajatarya merged 7 commits intomainfrom
rajat/diagnostic_scripts

Conversation

@rajatarya
Copy link
Collaborator

  • Adds diagnostic scripts to root of repo and references them in README.
  • Also reorganizes README to make diagnostics & debugging more visible.

@rajatarya rajatarya requested review from Copilot and jsulz September 11, 2025 17:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds diagnostic scripts for debugging hangs and performance issues with hf-xet, along with reorganizing the README to make diagnostics and debugging information more prominent and accessible.

  • Adds Linux and Windows diagnostic scripts that automatically collect system info, download debug symbols, and capture periodic stack traces or dumps
  • Reorganizes README structure to move debugging content earlier and make it more visible to users encountering issues
  • Updates contribution section placement for better README flow

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
hf-xet-diag-linux.sh Linux diagnostic script using gdb/gcore for stack traces and core dumps, with optional ptrace helper
hf-xet-diag-windows.sh Windows diagnostic script using ProcDump for periodic mini dumps, designed for Git-Bash
README.md Reorganized to promote diagnostics section and added comprehensive documentation for the diagnostic scripts

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

rajatarya and others added 4 commits September 11, 2025 10:19
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@rajatarya rajatarya requested review from hoytak and seanses September 11, 2025 17:20
Copy link
Contributor

@jsulz jsulz left a comment

Choose a reason for hiding this comment

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

Nice!!!!

@rajatarya rajatarya merged commit c762c68 into main Sep 11, 2025
6 checks passed
@rajatarya rajatarya deleted the rajat/diagnostic_scripts branch September 11, 2025 21:54
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