[CI:DOCS] Fix long option format on docs.podman.io #9856
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Luap99 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 Signed-off-by: Paul Holzinger <[email protected]>
|
LGTM, as long as the manpages still look OK |
|
I checked the man pages. |
|
@Luap99 thanks for the fix, I was really hoping to avoid backslashing all the arguments and just do add a change in the compilation process to make that happen automatically. This does fix the final issue though. @edsantiago would there be an easy way to verify in your PR scrubbing script that the double dashes for a long option in any man page changes are backslashed? |
|
@TomSweeneyRedHat already on my TODO list as of this morning; sorry for not having it done already (podman-buildah-bud is keeping me really busy!) |
|
I had to change the |
PR containers#9856 works around a buggy markdown processor that cleverly converts double dashes to em-dash. The unfortunate result is that the man page source files are unmaintainable, because every '--foo' has to be specified as '\-\-foo'. This is impossible for humans to remember, so let's add a helpful diagnostic message when we detect new options added without the escapes. Signed-off-by: Ed Santiago <[email protected]>
PR containers#9856 works around a buggy markdown processor that cleverly converts double dashes to em-dash. The unfortunate result is that the man page source files are unmaintainable, because every '--foo' has to be specified as '\-\-foo'. This is impossible for humans to remember, so let's add a helpful diagnostic message when we detect new options added without the escapes. Signed-off-by: Ed Santiago <[email protected]>
Rename Readme.md to README.md in the docs directory. Add the local build process per @Luap99 in containers#9856 for the man pages to preview any changes that are made. Signed-off-by: TomSweeneyRedHat <[email protected]>
github-actions
bot
added
the
locked - please file new issue/PR
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.
This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
Preview the html files in docs/build/html with
python -m http.server 8000 --directory build/html.Fixes containers/podman.io#373