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.

Sign up for GitHub

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

Jump to bottom

readme missing instructions on config_file json #2

Open
mimir-d opened this issue Sep 13, 2023 · 2 comments
Open

readme missing instructions on config_file json #2

mimir-d opened this issue Sep 13, 2023 · 2 comments
Assignees
@sksekar
Labels
documentation Improvements or additions to documentation

Comments

@mimir-d
Copy link
Contributor

mimir-d commented Sep 13, 2023

  • the binary uses an input json with specification of what pcie devices to use and what kind of margining
  • there should be some documentation in the readme as to what those fields are and/or how to create such a file
@mimir-d mimir-d added the documentation Improvements or additions to documentation label Sep 13, 2023
@caggio
Copy link
Collaborator

caggio commented Sep 21, 2023

Added a Howto @ https://github.com/opencomputeproject/ocp-diag-pci_lmt/blob/f729bb634b428ff0b69b6aeff876d2e88c912b11/HOWTO_example.txt

@mimir-d
Copy link
Contributor Author

mimir-d commented Sep 9, 2024

sure, that's good, but that kind of doc should be in the wiki. Or reformatted to be in the main readme (without that huge block of output). @sksekar leaving this #2 issue with you

@mimir-d mimir-d assigned mimir-d and sksekar and unassigned mimir-d Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sksekar sksekar

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@caggio @mimir-d @sksekar