Re: [Openstack] [devstack] Malformed Documentation on stack.sh script web site
thanks dean, looks beautiful now! :) On Wed, Nov 7, 2012 at 4:29 PM, Dean Troyer dtro...@gmail.com wrote: On Wed, Nov 7, 2012 at 9:27 AM, Gui Maluf guimal...@gmail.com wrote: In http://devstack.org/stack.sh.html above Log Files, the whole documentation is malformed. All descriptions stop to match with the current piece of code. I don't know who to warn, so I'm sending this email here. Actually, it is the reverse that is the case...everything _after_ Log Files is broken. We use shocco to format those pages from the bash scripts. It treats the comments as documentation and puts it to the left of the code that follows. This is why there is markdown formatting in the comments of devstack scripts. In this particular case, the spinner string was being improperly recognized by shocco and it stopped formatting the output. This is a good excuse to do another periodic doc/formatting pass through stack.sh, I'll commit this fix then. dt -- Dean Troyer dtro...@gmail.com -- *guilherme* \n \tab *maluf* ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
[Openstack] [devstack] Malformed Documentation on stack.sh script web site
In http://devstack.org/stack.sh.html above Log Files, the whole documentation is malformed. All descriptions stop to match with the current piece of code. I don't know who to warn, so I'm sending this email here. Hope it'll be fixed! att -- *guilherme* \n \tab *maluf* ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
Re: [Openstack] [devstack] Malformed Documentation on stack.sh script web site
On Wed, Nov 7, 2012 at 9:27 AM, Gui Maluf guimal...@gmail.com wrote: In http://devstack.org/stack.sh.html above Log Files, the whole documentation is malformed. All descriptions stop to match with the current piece of code. I don't know who to warn, so I'm sending this email here. Actually, it is the reverse that is the case...everything _after_ Log Files is broken. We use shocco to format those pages from the bash scripts. It treats the comments as documentation and puts it to the left of the code that follows. This is why there is markdown formatting in the comments of devstack scripts. In this particular case, the spinner string was being improperly recognized by shocco and it stopped formatting the output. This is a good excuse to do another periodic doc/formatting pass through stack.sh, I'll commit this fix then. dt -- Dean Troyer dtro...@gmail.com ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
