12. Developer’s guide

This section is here for those who are building/exploring the internals of PMIx in its source code form, most likely through a developer’s tree (i.e., a Git clone).

If you are simply using PMIx, you probably don’t need to read this section.

• 12.1. Prerequisites
  • 12.1.1. Compilers
  • 12.1.2. GNU Autotools
  • 12.1.3. Perl
  • 12.1.4. Flex
  • 12.1.5. Sphinx (and therefore Python)
• 12.2. GitHub, Git, and related topics
  • 12.2.1. GitHub
  • 12.2.2. Git commits: open source / contributor’s declaration
  • 12.2.3. Git branch scheme
  • 12.2.4. CI (testing)
• 12.3. Compiler Pickyness by Default
• 12.4. Running autogen.pl
• 12.5. Building PMIx
• 12.6. OpenPMIx terminology
  • 12.6.1. Modular Component Architecture (MCA)
  • 12.6.2. Required 3rd party libraries
• 12.7. Source code
  • 12.7.1. Code style
  • 12.7.2. Tree layout
  • 12.7.3. Symbol Visibility
• 12.8. Internal frameworks
  • 12.8.1. Framework notes
  • 12.8.2. MCA parameter notes
• 12.9. Manually installing the GNU Autootools
  • 12.9.1. Use a package manager
  • 12.9.2. Autotools versions
  • 12.9.3. Checking your versions
  • 12.9.4. Installing the GNU Autotools from source
  • 12.9.5. Build and install ordering
• 12.10. Installing and running Sphinx (building the OpenPMIx docs)
  • 12.10.1. Installing Python
  • 12.10.2. Installing Sphinx
  • 12.10.3. Running Sphinx
• 12.11. ReStructured Text for those who know Markdown
  • 12.11.1. Whitespace and indenting
  • 12.11.2. Fixed width font
  • 12.11.3. Italics
  • 12.11.4. Boldface
  • 12.11.5. Chapter and section delimiters
  • 12.11.6. Multi-line code/fixed-width font
  • 12.11.7. Un-numbered bullets
  • 12.11.8. Numbered bullets:
  • 12.11.9. Comments
  • 12.11.10. Including files
  • 12.11.11. Hyperlinks to URLs
  • 12.11.12. Hyperlinks to anchors
  • 12.11.13. Hyperlinks to other (RST) pages
  • 12.11.14. Macros
  • 12.11.15. Brightly-colored boxes