Skip to content

Documentation: v5.0.x man page items #10481

Open
@jsquyres

Description

@jsquyres
  • It’s possible that a lot of tokens in the RST man pages should be tokens.
  • Look for “See the ___ section” text and create appropriate cross references.
  • There’s some shmem man pages with list that have incorrect indentation in the RST, which results in odd line break, extra bold face, and strange indentation.
    • Example: man-openshmem/man3/shmem_double_prod_to_all.3.html – look for the description of “target”.
  • It looks like much of the cross-linking that we have in the MPI man pages (e.g., when one MPI API is mentioned on a page, it automatically links to the man page for that API) doesn’t exist in the OSHMEM pages.
  • Some of our code blocks have line numbers, others do not. I think I prefer to have the line numbers, but don’t feel too strongly about it.
  • Ensure somewhere that it is documented – probably in the networking section? – that it is necessary for resource manager daemons to have their /etc/security limits set properly for locked memory.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions