Open Stack

On 02/09/2014 07:43 AM, Thomas Goirand wrote:
> On 02/09/2014 01:58 AM, Andreas Jaeger wrote:
>> On 02/08/2014 02:52 PM, Thomas Goirand wrote:
>>> Hi,
>>>
>>> I tried packaging openstack-doc-tools, but there's a few issues.
>>>
>>> First, there are scripts with the ".sh" extension in /usr/bin. That's
>>> forbidden by the Debian policy. So, build-ha-guide.sh and
>>> makdown-docbook.sh would have to be renamed.
>>>
>>> Then, some names are a way too generic, and I don't feel comfortable
>>> uploading that to Debian:
>>> - build-ha-guide.sh
>>> - generatedocbook
>>> - generatepot
>>> - markdown-docbook.sh
>>>
>>> So, would it be possible to rename all these files in /usr/bin, so that
>>> I can package openstack-doc-tools correctly in Debian?
>>>
>>> Your thoughts?
>>
>> markdown-docbook.sh and build-ha-guide.sh are used internally by
>> openstack-doc-test. We could install them in /usr/lib instead of
>> /usr/bin. Do you have a suggestion for this? Renaming/moving them is
>> easy since these are "internal" tools and we need to change only the
>> packaging site and os_doc_tools/doctest.py.
> 
> Either ways, I'm fine, as long as it doesn't contaminate the standard
> path namespace. If it's only used on a single place and it's not
> intended to be use by our users, then probably /usr/lib or /usr/share is
> best.
> 
>> generatedocbook and generatepot are used from tox.ini and need to be in
>> usr/bin. If you have a proposal for new names, please send it.
> 
> Just pre-fixing it with "openstackdoc" would be IMO fine.
> 
>> We can
>> change those but need to do it carefully so that we do not break the
>> gates. I would do it in a few steps - first step add a new name and
>> leave the old as link, get it in, then change all files that use it to
>> use the new name and then remove the old names.
>>
>> Patches and concrete suggestions are welcome,
>> Andreas
> 
> I am unfortunately short on available time, and would appreciate if
> someone else than me could take care of this. But your plan seems the
> correct thing to do.

First patch at:
https://review.openstack.org/72135

Please comment on whether this change is fine,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126