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).

Comments

marvil07’s picture

Priority: Critical » Normal
Issue tags: -versioncontrol-6.x-2.0-release-blocker

I 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:

marvil07’s picture

Just added docs for hook_versioncontrol_code_arrival()

marvil07’s picture

This will be unblocked when we removed enough unrelevant code.

tizzo’s picture

Assigned: Unassigned » tizzo

Taking this one on.

tizzo’s picture

Status: Active » Needs review
StatusFileSize
new0 bytes

Adding docs for all of the hooks that I could find and fine tuning the high level description.

tizzo’s picture

Patch isn't empty this time...

tizzo’s picture

StatusFileSize
new5.28 KB

K last one wasn't empty... and wasnt the right one.

Sorry guys. Here ya go!

marvil07’s picture

Version: 6.x-2.x-dev » 7.x-1.x-dev
Status: Needs review » Needs work

Thanks 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.

marvil07’s picture

Assigned: tizzo » marvil07
Status: Needs work » Needs review
StatusFileSize
new136.92 KB

I opened a new topic branch called doc-d7, and it has some tweaking on the current documentation. Current commits there:

c840acd Issue #1291904 follow-up: Moves the backend module to an examples directory.
3d30df0 Issue #1291904 follow-up: Adds a note about 7.x-1.x branch to README.
7f3a208 Issue #1291904 follow-up: Removes unmaintained changelog file.
5d18753 Issue #1291904 follow-up: Removes documentation of dead hook_versioncontrol_authorization_methods().
61f0a0e Issue #983926 follow-up: Removes unused repository authorization_method.
34f8ba7 Issue #1291904 follow-up: Fixes typo.
ab7667b Issue #1291904 follow-up: Updates doxygen configuration file.
fb70423 Issue #1291904 follow-up: Removes OOP_TODO moving useful information elsewhere.

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).

marvil07’s picture

StatusFileSize
new26.25 KB
new159.76 KB

The 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.

154e392 Issue #1291904 follow-up: Adds event and its controller class to the example backend implementation.
ed79fdd Issue #1291904 follow-up: Adds hook_schema for example backend module.
a450f86 Issue #1291904 follow-up: Minor documentation block formatting.
f18e3ad Issue #1291904 follow-up: Adds info file for example backend module.
2c1261c Issue #1291904 follow-up: Start an example reposync plugin for fake backend module, unfinished.
marvil07’s picture

Version: 7.x-1.x-dev » 6.x-2.x-dev
Status: Needs review » Patch (to be ported)

After 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:

2903862 Issue #1291904 follow-up: Moves the backend module to an examples directory.
f975352 Issue #1291904 follow-up: Documentation files tweaking.
612ca59 Issue #1291904 follow-up: Minor documentation block formatting.
c3fd5f4 Issue #1291904 follow-up: Documentation updates on example backend module.

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.

marvil07’s picture

Status: Patch (to be ported) » Needs review
StatusFileSize
new142.48 KB

Let testbot agree before actually adding this commit series.

Minor changes reflected in commit comments:

  • Port hook_update_N() to D6.
  • Do not add the note about 7.x-1.x branch to README.
marvil07’s picture

Status: Needs review » Fixed

Added to 6.x-2.x

Automatically closed -- issue fixed for 2 weeks with no activity.

  • Commit 7e25f1f on 6.x-2.x, repository-families, drush-vc-sync-unlock by marvil07:
    Issue #1291904: Bring back some handbook documentation into the project...
  • Commit d57bca5 on 6.x-2.x, repository-families, drush-vc-sync-unlock by marvil07:
    Issue #1291904: Update api documentation for entity CRUD hooks.
    
    
  • Commit 1dec750 on 6.x-2.x, repository-families, drush-vc-sync-unlock by marvil07:
    Issue #1291904: Remove deprecated hooks from documentation file.
    
    
  • Commit 81c495e on 6.x-2.x, repository-families, drush-vc-sync-unlock by marvil07:
    Issue #1291904: First round of updates to the example fakevcs backend...
  • Commit fda7abf on 7.x-1.x, repository-families, drush-vc-sync-unlock by marvil07:
    Issue #1291904: Add documentation for the versioncontrol_code_arrival...
  • Commit 1270abb on 7.x-1.x, drush-vc-sync-unlock authored by tizzo, committed by marvil07:
    Issue #1291904 by tizzo: Complete hooks documentation.
    
    Also, minor...
  • Commit 2903862 on 7.x-1.x, drush-vc-sync-unlock by marvil07:
    Issue #1291904 follow-up: Moves the backend module to an examples...
  • Commit f975352 on 7.x-1.x, drush-vc-sync-unlock by marvil07:
    Issue #1291904 follow-up: Documentation files tweaking.
    
    - Removes...
  • Commit 612ca59 on 7.x-1.x, drush-vc-sync-unlock by marvil07:
    Issue #1291904 follow-up: Minor documentation block formatting.
    
  • Commit c3fd5f4 on 7.x-1.x, drush-vc-sync-unlock by marvil07:
    Issue #1291904 follow-up: Documentation updates on example backend...

  • Commit 7e25f1f on 6.x-2.x, repository-families by marvil07:
    Issue #1291904: Bring back some handbook documentation into the project...
  • Commit d57bca5 on 6.x-2.x, repository-families by marvil07:
    Issue #1291904: Update api documentation for entity CRUD hooks.
    
    
  • Commit 1dec750 on 6.x-2.x, repository-families by marvil07:
    Issue #1291904: Remove deprecated hooks from documentation file.
    
    
  • Commit 81c495e on 6.x-2.x, repository-families by marvil07:
    Issue #1291904: First round of updates to the example fakevcs backend...
  • Commit fda7abf on 7.x-1.x, repository-families by marvil07:
    Issue #1291904: Add documentation for the versioncontrol_code_arrival...
  • Commit 1270abb on 7.x-1.x authored by tizzo, committed by marvil07:
    Issue #1291904 by tizzo: Complete hooks documentation.
    
    Also, minor...
  • Commit 2903862 on 7.x-1.x by marvil07:
    Issue #1291904 follow-up: Moves the backend module to an examples...
  • Commit f975352 on 7.x-1.x by marvil07:
    Issue #1291904 follow-up: Documentation files tweaking.
    
    - Removes...
  • Commit 612ca59 on 7.x-1.x by marvil07:
    Issue #1291904 follow-up: Minor documentation block formatting.
    
  • Commit c3fd5f4 on 7.x-1.x by marvil07:
    Issue #1291904 follow-up: Documentation updates on example backend...