Skip to content

Comments

README and fabtests/README.md: enhance the README#11888

Merged
shijin-aws merged 3 commits intoofiwg:mainfrom
shijin-aws:docs
Feb 19, 2026
Merged

README and fabtests/README.md: enhance the README#11888
shijin-aws merged 3 commits intoofiwg:mainfrom
shijin-aws:docs

Conversation

@shijin-aws
Copy link
Contributor

Add more build instructions and high level usage examples which covers different execution paths.

@shijin-aws
Copy link
Contributor Author

shijin-aws commented Feb 12, 2026

There is a https://github.com/ofiwg/libfabric/blob/main/fabtests/man/fabtests.7.md man page which already have the usage examples for some test, but it is not intuitive for new users to find this man page compared to the README file.

This PR enhanced the README with basic examples and adds a reference to that man page for detailed usage

@shijin-aws shijin-aws changed the title fabtests/README.md: enhance the README README and fabtests/README.md: enhance the README Feb 12, 2026
@shijin-aws shijin-aws requested a review from j-xiong February 12, 2026 04:38
@shijin-aws shijin-aws force-pushed the docs branch 2 times, most recently from 45ffe53 to fd0693d Compare February 13, 2026 04:07
a-szegel
a-szegel previously approved these changes Feb 13, 2026
@shijin-aws shijin-aws requested a review from j-xiong February 13, 2026 21:06
The current description is inaccurate, fix it.

Signed-off-by: Shi Jin <sjina@amazon.com>
Enable SynapseAI build and fail if not found. Optional=<Path to where the SynapseAI libraries and headers are installed.> This enables SynapseAI memory support for heterogeneous memory (HMEM) testing.

```
--with-ze
Copy link
Contributor

Choose a reason for hiding this comment

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

missed a change here:
--with-ze[=DIR]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops, updated

Add more build instructions and high level usage examples which covers different execution paths.

Signed-off-by: Shi Jin <sjina@amazon.com>
Explain some common configure options

Signed-off-by: Shi Jin <sjina@amazon.com>
@shijin-aws
Copy link
Contributor Author

@j-xiong I am sure the Intel CI is unrelated, but like to restart it to have a green pass.

@j-xiong
Copy link
Contributor

j-xiong commented Feb 18, 2026

@shijin-aws A rerun has been scheduled, waiting in the queue.

@shijin-aws shijin-aws merged commit 8c4eb96 into ofiwg:main Feb 19, 2026
22 of 24 checks passed
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