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.

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

Fix manpage formatting for list items #9659

Merged

Conversation

juanvallejo
Copy link
Contributor

@juanvallejo juanvallejo commented Jun 30, 2016

Related trello card: https://trello.com/c/SbXIB0sW/595-3-cli-man-pages-for-oc-oadm-openshift
Fixes bugzilla bug: https://bugzilla.redhat.com/show_bug.cgi?id=1351059

There is a bug in the package github.com/cpuguy83/go-md2man/md2man that causes lists to be rendered incorrectly in manpages, with arbitrary characters and no linebreaks between items.

Before
       0

              item  "start": after old deployments are scaled to zero item "pre": after the pre hook completes (even
              if no hook specified) item "mid": after the mid hook completes (even if no hook specified) item A per‐
              centage of the deployment, based on which strategy is in use

       0

              item  "0%"    Recreate  after the previous deployment is scaled to zero item "N%"   Recreate after the
              acceptance check if this is not the first deployment item "0%"   Rolling  before the  rolling  deploy‐
              ment is started, equivalent to "pre" item "N%"   Rolling  the percentage of pods in the target deploy‐
              ment that are ready item "100%" All      after the deployment is at full scale, but  before  the  post
              hook runs
After
              · "start": after old deployments are scaled to zero

              · "pre": after the pre hook completes (even if no hook specified)

              · "mid": after the mid hook completes (even if no hook specified)

              · A percentage of the deployment, based on which strategy is in use

              · "0%"   Recreate after the previous deployment is scaled to zero

              · "N%"   Recreate after the acceptance check if this is not the first deployment

              · "0%"   Rolling  before the rolling deployment is started, equivalent to "pre"

              · "N%"   Rolling  the percentage of pods in the target deployment that are ready

              · "100%" All      after the deployment is at full scale, but before the post hook runs

@juanvallejo
Copy link
Contributor Author

[test]

@juanvallejo
Copy link
Contributor Author

@fabianofranz could you take a look please? thanks!

@fabianofranz
Copy link
Member

LGTM, [merge]

@juanvallejo Once this gets merged please move the bug to ON_QA with a comment pointing to this PR. Also, does this affect upstream? If so might be worth submitting the patch or at least open an issue to let them know. Tks!

@juanvallejo
Copy link
Contributor Author

Possible flake? re[test]

@juanvallejo
Copy link
Contributor Author

juanvallejo commented Jun 30, 2016

@fabianofranz

does this affect upstream? If so might be worth submitting the patch or at least open an issue to let them know

So far, I have not seen the use of "" to indicate lists in any of their commands' help. Use of "" and "-" in our commands was the overall cause for misprinted lists on the man pages. I will keep checking though.

@fabianofranz
Copy link
Member

flake, [merge] again

@juanvallejo juanvallejo force-pushed the jvallejo_fix-manpage-list-format branch from 669a8aa to e4a663a Compare July 1, 2016 19:50
@fabianofranz
Copy link
Member

Plz Jenkins, can't we have nice things on a friday night? re[merge]

@fabianofranz
Copy link
Member

[merge]

@openshift-bot
Copy link
Contributor

openshift-bot commented Jul 4, 2016

continuous-integration/openshift-jenkins/merge SUCCESS (https://ci.openshift.redhat.com/jenkins/job/test_pr_origin/5813/) (Image: devenv-rhel7_4533)

@fabianofranz
Copy link
Member

@juanvallejo keep rebasing with master and updating generated docs, so that we don't get bitten by doc changes coming from other PR's. I have a few in the merge queue that will likely affect this.

@juanvallejo juanvallejo force-pushed the jvallejo_fix-manpage-list-format branch from e4a663a to b001462 Compare July 5, 2016 15:14
@juanvallejo juanvallejo force-pushed the jvallejo_fix-manpage-list-format branch from b001462 to db9d39a Compare July 5, 2016 22:30
@openshift-bot
Copy link
Contributor

Evaluated for origin test up to db9d39a

@openshift-bot
Copy link
Contributor

continuous-integration/openshift-jenkins/test SUCCESS (https://ci.openshift.redhat.com/jenkins/job/test_pr_origin/5811/)

@fabianofranz
Copy link
Member

[merge]

@openshift-bot
Copy link
Contributor

Evaluated for origin merge up to db9d39a

@openshift-bot openshift-bot merged commit 7bdd7ae into openshift:master Jul 6, 2016
@juanvallejo juanvallejo deleted the jvallejo_fix-manpage-list-format branch July 6, 2016 13:09
@fabianofranz
Copy link
Member

\o/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants