[GEODE-9759] User Guide: gfsh command pages - problem with double-hyphens

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Resolved
• Affects Version/s: 1.14.0
• Fix Version/s: 1.12.10, 1.14.5, 1.15.0
• Component/s: docs
• Labels: pull-request-available
• Assignee: Max Hufnagel
• Reporter: Dave Barnes
• Created: 21/Oct/21 23:09
• Updated: 22/Jun/22 20:45
• Resolved: 09/May/22 22:15

Description

In the tables of gfsh command options, double-hyphen prefixes are often (but not always) collapsed to a single hyphen.

This is a format issue with dozens (possibly hundreds?) of occurrences.

See, for example, the `alter` command page, http://geode.apache.org/docs/guide/114/tools_modules/gfsh/command-pages/alter.html.
Note the difference between the entry for `--entry-idle-time-expiration-action` and the following entry `-entry-time-to-live-expiration`. The tricky bit is that the source code in both cases uses the same HTML construct: `<td><span class="keyword parmname">--entry-time-to-live-expiration</span></td>`, but the results differ.

One likely remedy is to replace the hyphen pair with the code for two non-breaking hyphens: `‑‑`.

Behavior may differ depending on whether the entry occurs in an HTML table, a nested HTML table, or a Markdown table.

Issue Links

• links to: GitHub Pull Request #7560
• links to: GitHub Pull Request #7597
• links to: GitHub Pull Request #7599