1
1
Jeff Squyres c960d292ec Convert all README files to Markdown
A mindless task for a lazy weekend: convert all the README and
README.txt files to Markdown.  Paired with the slow conversion of all
of our man pages to Markdown, this gives a uniform language to the
Open MPI docs.

This commit moved a bunch of copyright headers out of the top-level
README.txt file, so I updated the relevant copyright header years in
the top-level LICENSE file to match what was removed from README.txt.

Additionally, this commit did (very) little to update the actual
content of the README files.  A very small number of updates were made
for topics that I found blatently obvious while Markdown-izing the
content, but in general, I did not update content during this commit.
For example, there's still quite a bit of text about ORTE that was not
meaningfully updated.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
Co-authored-by: Josh Hursey <jhursey@us.ibm.com>
2020-11-10 13:52:29 -05:00

31 строка
1013 B
Markdown

# Open MPI extension: Affinity
## Copyrights
```
Copyright (c) 2010-2012 Cisco Systems, Inc. All rights reserved.
Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
```
## Authors
* Jeff Squyres, 19 April 2010, and 16 April 2012
* Terry Dontje, 18 November 2010
## Description
This extension provides a single new function, `OMPI_Affinity_str()`,
that takes a format value and then provides 3 prettyprint strings as
output:
* `fmt_type`: is an enum that tells `OMPI_Affinity_str()` whether to
use a resource description string or layout string format for
`ompi_bound` and `currently_bound` output strings.
* `ompi_bound`: describes what sockets/cores Open MPI bound this process
to (or indicates that Open MPI did not bind this process).
* `currently_bound`: describes what sockets/cores this process is
currently bound to (or indicates that it is unbound).
* `exists`: describes what processors are available in the current host.
See `OMPI_Affinity_str(3)` for more details.