Searchable man pages - Githubissues

ofiwg / libfabric

Open Fabric Interfaces

http://libfabric.org/

Other

555 stars 376 forks source link

Searchable man pages #9021

Open a-szegel opened 1 year ago

a-szegel commented 1 year ago

I would like to be able to search libfabric man pages so that I can quickly find the answer to my question instead of:

Asking for help
- Invasive of other developers time
Opening up every man page + (OFI Developers Guide) and using cntrl-f
- Slow
Trying to google
- often not effective
Reading the code
- Takes a lot of time to answer simple high level questions

a-szegel commented 1 year ago

I was trying to look up what FI_DIRECTED_RECV was, and in order to do so, I opened up 32 man pages, and found it on the 21st man page (fi_getinfo).... I wasn't sure where FI_DIRECTED_RECV fit in (msg, rma, ep....), so it took me longer than it should have to find. If I had a simple search bar at the top of the docs, this would have been trivial.

thomasgillis commented 1 year ago

Following this, here is another suggestion that came across a few times: having a fixed link to the latest version of the manpage would also be helpful (.../libfabric/latest/man/... instead of .../libfabric/v1.18.1/man/...)

j-xiong commented 1 year ago

The latest man pages are here: https://ofiwg.github.io/libfabric/main/man/

j-xiong commented 6 months ago

Not a 2.0 specific feature. It's an enhancement to the git hub man pages web interface.

j-xiong commented 6 months ago

We could create a single page version of all the man pages (maybe a pdf).