I have just updated a little the api file, but it is completely outdated.
Since this is an api module, marking as critical and release blocker.
Some things to do here:
- Search for every hook defined on the module and add it to api file.
- Update the example backend(versioncontrol_fakevcs) showing all backend specific interaction(specially oop).
| Comment | File | Size | Author |
|---|---|---|---|
| #13 | 1291904-13.patch | 142.48 KB | marvil07 |
| #11 | 1291904-11.patch | 159.76 KB | marvil07 |
| #11 | interdiff.txt | 26.25 KB | marvil07 |
| #10 | 1291904-10.patch | 136.92 KB | marvil07 |
| #8 | versioncontrol-docs-1291904-7.patch | 5.28 KB | tizzo |
Comments
Comment #1
marvil07 commentedI am removing the tag because I have updated the two items mentioned originally in the issue.
What's left here now is: review and update doxygen docblocks when it's applicable.
Related commits added upstream:
Comment #2
marvil07 commentedJust added docs for
hook_versioncontrol_code_arrival()Comment #3
marvil07 commentedThis will be unblocked when we removed enough unrelevant code.
Comment #4
tizzo commentedTaking this one on.
Comment #5
tizzo commentedAdding docs for all of the hooks that I could find and fine tuning the high level description.
Comment #6
tizzo commentedPatch isn't empty this time...
Comment #8
tizzo commentedK last one wasn't empty... and wasnt the right one.
Sorry guys. Here ya go!
Comment #9
marvil07 commentedThanks for the new documentation :-) I've added it to both 7.x-1.x and 6.x-2.x branches.
I forgot one thing, IMHO is important. We provide an example backend module(versioncontrol_fakevcs), which I initially clean up a little because of this issue, but it is still a little far from being functional/complete.
A good idea could be add an info file on local development to find out what is missing, the next step could be to check versioncontrol_git implementation to remember what we are missing there.
Update: Also it's a good idea is to look at the test backend, which is updated with main code.
Comment #10
marvil07 commentedI opened a new topic branch called doc-d7, and it has some tweaking on the current documentation. Current commits there:
It still needs what is mentioned on comment 9, moving to NR for testbot (I'm making a minor schema change to clean an old non-used field and be sure it's not used anywhere).
Comment #11
marvil07 commentedThe backend code seems to be good enough now, but I am adding one more thing before rebasing/merging this topic branch into mainline: Provide an example reposync plugin.
Comment #12
marvil07 commentedAfter thinking on this a little more, I decided to separate the last bit on a different issue: #2009948: Provide an example reposync plugin, which should not block a stable release.
See added commits:
Also I added another not-completely-related one(relevant in the sense of better documentation is also about removing unused information):
4df6600 Issue #983926 follow-up: Removes unused repository authorization_method.Then, marking NW for D6 version of this last set of patches.
Comment #13
marvil07 commentedLet testbot agree before actually adding this commit series.
Minor changes reflected in commit comments:
Comment #14
marvil07 commentedAdded to 6.x-2.x