MAN: updated man-pages for lots of RMA window functions

[zerothi]

The updates adds explanations of different MODES for the
window synchronization routines as well as providing a bit
more context for the baseptr (void *) data-types which are actually
void ** types.

Also added more cross-links.

Finally added explanations of the Win_create_dynamic usage that explicitly
requires attention about address spaces. I.e. the actual address at the target
is necessary for succesfull operation.

This fixes #8680.

[ompiteam-bot]

Can one of the admins verify this patch?

[zerothi]

I would be happy to repeat this for v4. branches, let me know when you think this will be appropriate. :)

[awlauria]

ok to test

[devreal]

@zerothi Thanks for taking on this task. The changes are definitely helpful. I have made some suggestions for word-smithing the language (and just realized that I didn't batch them, sorry for the noise...)

[jsquyres]

@zerothi The sooner we can get this merged to master, the better, because we're actively working on converting the man pages to ReStructured text / Sphinx.

Thanks!

[zerothi]

I haven't been able to do anything due to Easter, but feel free to amend however you wish, I can work on this tomorrow evening or 2 days from now. I am all busy tomorrow...

[zerothi]

ok, I found 5 minutes, I amended nearly everything @devreal suggested. Thanks.
I did not mention C explicitly in the parts that are already in C notes sections. It seemed redundant to me :)

[devreal]

Thanks @zerothi, looks good now :)

[jsquyres]

@zerothi CI found an error -- can you update the .mailmap file?

/usr/bin/perl "./contrib/dist/make-authors.pl" --skip-ok --quiet --srcdir="."

*** WARNING: The following people had the same email address:
***   Nick Papior, Nick Papior Andersen

*******************************************************************************
*** YOU SHOULD EDIT THE .mailmap FILE TO RESOLVE THESE WARNINGS!
*******************************************************************************

[zerothi]

It seems the same error occurs... I have no idea how to fix it.
Nick Papior and Nick Papior Andersen are both me. Hence two emails for different names.

Please feel free to amend anything that fixes this, squash, merge and commit and lets get this in... :)

[zerothi]

I don't know if the test should just restart? I can't see any clue in the console output? Seems like it just fails due to time?

[jsquyres]

I don't know if the test should just restart? I can't see any clue in the console output? Seems like it just fails due to time?

Sometimes we see Jenkins try to git clone from github and it fails with that git error (reference is not a tree). 🤷‍♂️

[jsquyres]

bot:ompi:retest

[zerothi]

Sometimes we see Jenkins try to git clone from github and it fails with that git error (reference is not a tree).

Ok great, hope it is ready to get merged!

[jsquyres]

@zerothi I just kicked it to run the CI test again. It'll almost certainly pass this time (we think the Jenkins issue is a race condition of some flavor -- e.g., possibly trying to check out the merge hash before it's actually available on github's CDNs).

[zerothi]

@zerothi I just kicked it to run the CI test again. It'll almost certainly pass this time (we think the Jenkins issue is a race condition of some flavor -- e.g., possibly trying to check out the merge hash before it's actually available on github's CDNs).

Perhaps a sleep could relieve the problem?

Great it's merged!