Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Issue tags:
Reporter:
Created:
15 Oct 2009 at 11:33 UTC
Updated:
3 Jan 2014 at 00:29 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonShouldn't this be included in the original issue report, rather than reporting as a separate issue?
Comment #2
jhodgdonI guess that other issue was too big so they closed it down and split it up.
Anyway, this is now part of the hooks meta-issue, and it's a bug report if this doc is missing (which it is).
#675046: Make sure all hooks in D7 have documentation
Comment #3
gddOK here's a start. The biggest problem I have is in hook_verify_update_archive(). So in #124 of the original issue, this is added with mention of it being used in contrib for things like code signing. However it is not anywhere in core (that I could find), so there's no easy place to grab a sample implementation from. Additionally, the calling code update_manager_archive_verify() indicates this should return $failures, but doesn't indicate what kind of data that is. It is checking !empty(), which seems weird, like it expects an array of some kind. If dww can provide some clarity there, that would be really helpful.
Otherwise the other two hooks seem pretty straightforward.
Comment #4
jhodgdonA few small style/punctuation changes:
--> Provide information on updaters (classes that can update Drupal).
keys. -> keys:
We generally don't put a $variable on the line with @return.
Anyway, it looks like we need dww or someone else who understands hook_verify_update_archive() to let us know what should be in that function doc and its example function body. The rest looks good to me so far.
Comment #5
jhodgdonHere's a new patch. I figured out what was going on and fixed up the documentation.
Comment #7
jhodgdonAnother patch just got committed - here's a reroll that should work...
Comment #8
dwwNice, thanks! Some of the actual info isn't quite right. I'm rerolling now. Stay tuned...
Comment #9
dww@jhodgdon: sorry, this is some really wonky, complex stuff that almost no one is ever going to use. :/ I tried to be as clear as possible, but the underlying technical stuff I'm attempting to explain is pretty sucky. ;) Please feel free to find better wording if you can, or ask me if this makes no sense.
Thanks!
-Derek
Comment #10
dwwActually, hook_verify_update_archive() is a hook by update.module, not system.module. Sorry that wasn't clear in the OP. Moved that doc block to update.api.php.
Comment #11
jhodgdondownload -> downloaded
(probably came from my patch in the first place?)
Otherwise, looks fine to me. I'll just make that change...
Comment #12
jhodgdon(better wait for test bot though in case I screwed it up)
Comment #13
aspilicious commentedTrailing white space
98 critical left. Go review some!
Comment #14
dwwComment #15
jhodgdonLooks good to me...
Comment #16
webchickCommitted to HEAD! Thanks!