DOC: Clarify vendored third-party fork conventions#6432
Open
hjmjohnson wants to merge 1 commit into
Open
Conversation
github-actions
Bot
added
type:Documentation
This comment was marked as resolved.
This comment was marked as resolved.
Document the divergent/pruned fork type (vxl/VNL) where <sha7> is the overlay-tip commit and <version> is master, and require branch-only overlay anchors (a same-named branch and tag make the ref ambiguous and break update-third-party.bash). Make ThirdPartyForkConventions.md the single source of truth for fork naming and updating_third_party.md the source for procedure; cross-link them and drop the stale for/itk naming restatements. Route to both from AGENTS.md and fix the VNL README link that pointed at a nonexistent Maintenance/UpdatingThirdParty.md.
hjmjohnson
force-pushed
the
doc-thirdparty-fork-conventions
branch
from
b836a3b to
1f722cf
Compare
Member
Author
|
Addressed the greptile finding in 1f722cf: the "Updating a Project" example now uses the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only: clarifies ITK's vendored third-party fork conventions and de-duplicates the two overlapping update docs. Prompted by @blowekamp's review on #6431, which flagged that the fork procedure was unclear about branch/tag anchoring and SHA provenance.
What changed
Documentation/Maintenance/ThirdPartyForkConventions.md— adds a two fork types table: release-tracking forks (eigen, DCMTK) use the upstream release + upstream-tag SHA; divergent/pruned forks (vxl/VNL) track no upstream release, so<version>ismasterand<sha7>is the overlay-tip commit. Adds a branches, never tags rule: a same-named branch and tag make a ref ambiguous (warning: refname is ambiguous) and breakupdate-third-party.bash.Documentation/docs/contributing/updating_third_party.md— removes the stalefor/itksingle-branch naming (which conflicted with thefor/itk-<project>-<version>-<sha7>convention) and defers all naming to ThirdPartyForkConventions.md. The two docs are now cross-linked: conventions = naming/structure, this doc = procedure.AGENTS.md— routes agents to both docs when updating a vendored dependency.Modules/ThirdParty/VNL/README.md— fixes a dead link that pointed at a nonexistentDocumentation/Maintenance/UpdatingThirdParty.md; now links the realupdating_third_party.mdand the conventions doc.Scope / testing
Documentation only — no code, no build/test impact.
pre-commit run --all-filespasses. Relative links in the VNL README verified to resolve.