Open Stack

On 09/06/2013 08:50 PM, Steve Gordon wrote:
> ----- Original Message -----
>> From: "Andreas Jaeger" <aj at suse.com>
>> To: "Christian Berendt" <berendt at b1-systems.de>, openstack-docs at lists.openstack.org
>> Sent: Friday, September 6, 2013 2:29:12 PM
>> Subject: [Openstack-docs] Broken tree since validate.py seems not to handle	removals properly
>>
>> A recent commit removed some files and that broke the build since the
>> file was still included in one place.
>>
>> Details:
>>
>> This change:
>>
>>     Update CLI chapter in the Admin User Guide
>>
>>     bug: #1218683
>>
>>     Change-Id: If3eb434f09c26e461e133db0f87ac24d63e3403d
>>
>> Removed openstack-user-admin/src/section_cli_set_compute_quotas.xml but
>> this file is used by common/section_compute-configure-quotas.xml - and
>> thus build fails.
> 
> This is one of the issues I noted in an earlier discussion about common content. It's difficult for someone editing a guide to see that their changes have impact on other guides if the content being edited was not moved to common when it became shared, and there's currently no checking to ensure this is done.
> 
>> What is the best way to fix this? Should we validate *all* books if any
>> file gets removed? Or can we grep through the sources and check that a
>> file is not xincluded anywhere?
> 
> Either approach will certainly prevent the removal of the file and thus the build failures, though I still wonder if at some point we should explore validation to prevent setting of such "traps" in the first place (that is preventing content from being shared without it being moved to common). Don't think we ever reached consensus on this though.
> 
> FWIW I have also used XSL to extract xi:includes from XML files, but have no doubt grep will beat it for speed:
> 
>     https://github.com/redhat-openstack/openstack-manuals-convert/blob/master/xsl/extract/xiincludes-xml.xsl

Interesting...

I'm coding right now without grep - using python. Something similar to
what you do in XSL.

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