Bug 1351059 - [userinterface_public_595] man commands return incorrect strings from man page files
Summary: [userinterface_public_595] man commands return incorrect strings from man pag...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OKD
Classification: Red Hat
Component: oc
Version: 3.x
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ---
: ---
Assignee: Juan Vallejo
QA Contact: Xingxing Xia
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-06-29 06:41 UTC by XiaochuanWang
Modified: 2016-09-19 13:54 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-09-19 13:54:37 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description XiaochuanWang 2016-06-29 06:41:57 UTC
Created attachment 1173671 [details]
screenshot_man_oc-deploy

Description of problem:
man commands like `man oc-deploy` returns some unreadable strings directly from man file.
Related us: https://trello.com/c/SbXIB0sW/595-3-cli-man-pages-for-oc-oadm-openshift

Version-Release number of selected component (if applicable):
oc v1.3.0-alpha.2-262-g587b06b
kubernetes v1.3.0-alpha.3-599-g2746284
fork_ami_openshift3_userinterface_public_595_246

How reproducible:
Always

Steps to Reproduce:
1. Generate man pages
# ./hack/update-generated-docs.sh
# ./hack/verify-generated-docs.sh
# ls -l docs/man/man1/

2. Export path
export MANPATH=$MANPATH:"$(pwd)/docs/man"
3. Check output like `man oc-deploy`
4. (To compare) Check man page file `origin/docs/man/man1/oc-deploy.1`

Actual results:
3. Contain the following string (please see attachment)
1) has the string "0...item"
2) "Recreate -" and "Custom  -" all in a same line and there is also a "item" before each one.
"""
       0

              item Rolling (default) - scales up the new deployment in stages, gradually reducing the number of old deployments. If one of the new deployed pods never becomes "ready",  the  new  deployment will  be  rolled  back  (scaled down to zero). Use when your application can tolerate two versions of code running at the same time (many web applications, scalable databases) item Recreate - scales the old deployment down to zero, then scales the new deployment up to full.  Use when your application cannot tolerate two versions of code running at the same time item Custom  -  run your own deployment process inside a Docker container using your own scripts.
"""

4. File has the "\item Rolling (default) \- scales up the ..."
`grep item origin/docs/man/man1/*` will return the related man files

Expected results:
1) Should not display "0" and "\item" directly.
2) "Recreate -" and "Custom  -" should start from a new line.

Additional info:

Comment 3 XiaochuanWang 2016-07-04 06:15:09 UTC
Not reproduced and verified on fork ami: 595_248
oc v1.3.0-alpha.2-347-ge4a663a


Note You need to log in before you can comment on or make changes to this bug.