* Brock Pytlik <[email protected]> [2009-10-14 01:57]:
> New webrev for bug 7960:
> http://cr.opensolaris.org/~bpytlik/ips-7960-v3/
>
> Bug:
> 7960 client and depot need different organization of files
>
> Note:
> Compared to v2, it resyncs with the gate and adds more info to the block
> comments for file_manager and layout.
Thanks.
*. Use PEP257 for docstrings. Run pydoc over your .py file to verify
that your documentation is relatively complete.
**. I think a use case to consider/document is the hypothetical
depotadm(1M) "update-repo" use case, where we would move every file in
the Original/V0 layout to its Fan256Once/V1 location.
layout.py:
25ff. Convert the bulk of this to a module docstring. I believe
Danek and I settled on a split: XXX comments never go in a
docstring, interface comments always do, and implementation
comments do when they are "notable".
25. Suggest """Layout - object to map content hashes to file paths"""
35. Rename Original to V0Layout. Rename Fant256Once to V1Layout. I
would invert the order, and describe V1 first, then V0 (and its
negative aspects), then a final paragraph on how to evaluate a
new Layout.
38. (Nit.) Prefer "readdir(3C) operation" to "a readdir".
44. Change to "The simplest layout is a flat layout, which has..."
and drop the "(henceforth...)" construction.
45-46. (Gr.) Incomplete sentence: "The first is that it makes
operating on the directory." Expensive, maybe?
47. (Nit.) "ls" -> "ls(1)".
49. (Nit.) "python's" -> "Python's".
56ff. Write up seems to suggest one must use all 4 bits of a
particular hex digit. If you restrict to 0-7, or 0-3, then
more fanout choices are available...
108. No get_preferred_layout() method?
file_manager.py:
25ff. Module docstring, please.
25. Suggest """FileManager - centralized object for insert, lookup,
and removal of files""".
I wonder if my use case "**" above suggests making a single
Layout-based FileManager, as well as the multiple Layout case we need
for the current depot? (FileManagerFactory?)
Thanks
Stephen
_______________________________________________
pkg-discuss mailing list
[email protected]
http://mail.opensolaris.org/mailman/listinfo/pkg-discuss
