Sure, I can make that change - but I'd love it if you made the edits. Docs are open for change.<br><br>Just do:<br>bzr branch lp:openstack-manuals trunk<br>bzr branch trunk edits<br><br>Make the edits in this file: <br>
doc/source/docbkx/os-objectstorage-devguide.xml<br><br>Then do:<br>bzr commit -m 'Edited to clarify path and prefix'<br>bzr push lp:~lpusername/openstack-manuals/edits<br><br>Then go to the Launchpad site and request a merge. <br>
Next I'll rebuild the docs (automation coming soon) and push the changed HTML (and PDF) to the docs site.<br><br>Let me know if you'd like to try it and I can walk you through on IRC or Skype. If not, I'll put it on my backlog.<br>
<br>Thanks,<br>Anne<br><div style="margin: 2em 0pt;" name="sig_d4a6b6619e"><div style="padding: 5px; font-size: 11px; color: rgb(102, 102, 102); font-family: sans-serif;">
<strong>Anne Gentle</strong>
<br>
<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a><br>
<div style="font-size: 10px;">
<a href="http://justwriteclick.com/" target="_blank">my blog</a> |
<a href="http://xmlpress.net/publications/conversation-community/" target="_blank">my book</a> |
<a href="http://www.linkedin.com/in/annegentle" target="_blank"><span>LinkedIn</span></a> | <a href="http://del.icio.us/annegentle" target="_blank">Delicious</a> |
<a href="http://twitter.com/annegentle" target="_blank">Twitter</a>
</div></div></div><div class="gmail_quote">2011/3/17 Juan J. <span dir="ltr"><<a href="mailto:juan@memset.com">juan@memset.com</a>></span><br><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<div class="im">On Thu, 2011-03-17 at 08:42 -0500, John Dickinson wrote:<br>
> A path query requires directory marker objects to be present (<a href="http://docs.openstack.org/openstack-object-storage/developer/content/ch03s02.html#d5e514" target="_blank">http://docs.openstack.org/openstack-object-storage/developer/content/ch03s02.html#d5e514</a>)<br>
<br>
</div>After reading the documentation again, I can see what you mean, but it<br>
isn't very obvious!<br>
<br>
Perhaps we should change the documentation to say explicitly to use<br>
prefix+delimiter and not path+delimiter?<br>
<br>
Having an example with delimiter in the same section as the path example<br>
is misleading, and there is no example of using prefix with delimiter.<br>
<div class="im"><br>
> I would recommend using prefix+delimiter over path. Path query<br>
> parameters are in swift to support backwards compatibility with<br>
> the original Cloud Files API.<br>
<br>
</div>This was the conclusion we came too as well, instead of using<br>
path="blah", use prefix="blah/", delimiter="/".<br>
<br>
Maybe Anne could do something about this!<br>
<br>
Regards,<br>
<br>
Juan<br>
<div><div></div><div class="h5"><br>
> --John<br>
><br>
> On Mar 17, 2011, at 8:12 AM, Juan J. Martínez wrote:<br>
><br>
> > Hello,<br>
> ><br>
> > We're having problems with the behaviour of path, prefix and delimiter<br>
> > parameters when calling list_objects, get_objects, etc; using<br>
> > python-cloudfiles and the Bexar release.<br>
> ><br>
> > I'm asking here because we don't know if this is a bug or the<br>
> > documentation is wrong [1].<br>
> ><br>
> > We're dealing with pseudo-hierarchical folders/directories, and when<br>
> > setting path we're not getting pseudo-directories (as the documentation<br>
> > seems to suggest with the given example).<br>
> ><br>
> > We're trying the following case:<br>
> ><br>
> > test/a/b/c.txt<br>
> > test/a/b/a.txt<br>
> > test/a/b.txt<br>
> > test/a.txt<br>
> ><br>
> > That means: 4 files, and 2 different pseudo-directories (using test/ as<br>
> > root for the tests).<br>
> ><br>
> > a. list_objects(prefix='test/')<br>
> ><br>
> > ['test/a.txt', 'test/a/b.txt', 'test/a/b/a.txt', 'test/a/b/c.txt']<br>
> ><br>
> > 4 files, as expected.<br>
> ><br>
> > b. list_objects(prefix='test/', delimiter='/')<br>
> ><br>
> > ['test/a.txt', 'test/a/']<br>
> ><br>
> > 1 file and 1 pseudo-directory, as you can see with 'subdir':<br>
> ><br>
> > c.list_objects_info(prefix='test/', delimiter='/')<br>
> ><br>
> > [{u'bytes': 13, u'last_modified': u'2011-03-17T11:46:03.596480',<br>
> > u'hash': u'e6a394bb2cdb1a7b044b37a48e024b2c', u'name': u'test/a.txt',<br>
> > u'content_type': u'text/plain'}, {u'subdir': u'test/a/'}]<br>
> ><br>
> > c. list_objects(path='test')<br>
> ><br>
> > ['test/a.txt']<br>
> ><br>
> > It's not returning any pseudo-directory (and according to common/db.py<br>
> > it can't).<br>
> ><br>
> > So our problem is 'path' query parameter. Is this the expected behaviour<br>
> > or is it a bug?<br>
> ><br>
> > Note: checking the code, path implies that prefix=path and<br>
> > delimiter='/'; and path won't return any pseudo-directories as shown in<br>
> > b).<br>
> ><br>
> > If someone can explain the path behaviour maybe we should provide a<br>
> > patch for the documentation, or submit a bug. Thanks!<br>
> ><br>
> > Kind regards,<br>
> ><br>
> > Juan<br>
> ><br>
> > [1]:<br>
> > <a href="http://docs.openstack.org/openstack-object-storage/developer/content/ch03s02.html#d5e407" target="_blank">http://docs.openstack.org/openstack-object-storage/developer/content/ch03s02.html#d5e407</a><br>
> ><br>
> > --<br>
> > Juan J. Martínez<br>
> > Development, MEMSET<br>
> ><br>
> > mail: <a href="mailto:juan@memset.com">juan@memset.com</a><br>
> > web: <a href="http://www.memset.com/" target="_blank">http://www.memset.com/</a><br>
> ><br>
> > Memset Ltd., registration number 4504980. 25 Frederick Sanger Road, Guildford, Surrey, GU2 7YD, UK.<br>
> ><br>
> ><br>
> > _______________________________________________<br>
> > Mailing list: <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
> > Post to : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
> > Unsubscribe : <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
> > More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
><br>
<br>
</div></div><font color="#888888">--<br>
Juan J. Martinez<br>
</font><div><div></div><div class="h5">Development, MEMSET<br>
<br>
mail: <a href="mailto:juan@memset.com">juan@memset.com</a><br>
web: <a href="http://www.memset.com/" target="_blank">http://www.memset.com/</a><br>
<br>
Memset Ltd., registration number 4504980. 25 Frederick Sanger Road, Guildford, Surrey, GU2 7YD, UK.<br>
<br>
<br>
_______________________________________________<br>
Mailing list: <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
Post to : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
Unsubscribe : <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
</div></div></blockquote></div><br>