Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve man-page formatting #716

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve man-page formatting #716

wants to merge 2 commits into from

Commits on Apr 20, 2023

  1. Improve man-page formatting 

    Current man-page renders as:
```
*OPTIONS*
       *SYSTEM*
              *interactive* A simple text-driven interactive interface
              to the Phoronix Test Suite.

       *php-conf*
              This option will print information that is useful to
              developers when debugging problems with the Phoronix
              Test Suite and/or test profiles and test suites.

       *shell*
              A simple text-driven shell interface / helper to the
              Phoronix Test Suite. Ideal for those that may be new
              to the Phoronix Test Suite

```

Note how "interactive" is indented differently than subsequent options,
which are themselves only indented to the level equal to the respective
subsection header.

Fix three things:
- Indent all options within a subsection equally by making them all
  "tagged paragraphs".
- Unindent subsection headers by changing them from "section headers"
  to "subsection headers".
- Change subsection headers to leading caps only in line with preferred
  man-pages style (man-pages(7)).

New rendering:
```
*OPTIONS*
   *System*
       *interactive*
              A  simple text-driven interactive interface to the Phoronix Test
              Suite.

       *php-conf*
              This option will print information that is useful to  developers
              when debugging problems with the Phoronix Test Suite and/or test
              profiles and test suites.

       *shell*  A simple text-driven shell interface / helper  to  the  Phoronix
              Test Suite. Ideal for those that may be new to the Phoronix Test
              Suite
```

Signed-off-by: Paul A. Clarke <pclarke@ventanamicro.com>
    @ThinkOpenly
    ThinkOpenly committed Apr 20, 2023
    Configuration menu
    Copy the full SHA
    3aa8eb0 View commit details
    Browse the repository at this point in the history

  2. Correct spell-o in "OpenBenchmarking" 

    Signed-off-by: Paul A. Clarke <pclarke@ventanamicro.com>
    @ThinkOpenly
    ThinkOpenly committed Apr 20, 2023
    Configuration menu
    Copy the full SHA
    9f3d3cf View commit details
    Browse the repository at this point in the history