Commit 8075b868 authored by Ben Boeckel's avatar Ben Boeckel

docs: add documentation for third party changes

parent 6d396af6
......@@ -110,13 +110,8 @@ A reader should have a general idea of the feature or fix to be developed given
Caveats:
* To add data follow [these instructions](data.md).
* If your change modifies the `Utilities/KWSys/vtksys` directory please
contribute directly to [KWSys][] instead.
* If your change modifies the `Utilities/MetaIO/vtkmetaio` directory please
contribute directly to [MetaIO][] instead.
[KWSys]: http://public.kitware.com/Wiki/KWSys/Git
[MetaIO]: https://github.com/Kitware/MetaIO
* If your change modifies third party code, see [its
documentation](../../../ThirdParty/UPDATING.md).
Share a Topic
-------------
......
# Updating Third Party Projects
When updating a third party project, any changes to the imported project
itself (e.g., the `zlib/vtkzlib` directory for zlib), should go through the
`update.sh` framework. This framework ensures that all patches to the third
party projects are tracked externally and available for (preferably) upstream
or other projects also embedding the library.
The projects listed in the [imported.md](imported.md) file are already using
this setup.
Any updates to projects not listed there should first convert over to this
framework.
# Updating a Project
Once converted, a project should be updated by applying patches to the
repository specified in its `update.sh` script. Once the changes are merged,
pulling the changes involves running the `update.sh` script. This will update
the local copy of the project to the version specified in `update.sh` (usually
a `for/foo` branch, but may be `master` or any other Git reference) and merge
it into the main tree.
This requires a Git 2.5 or higher due the `worktree` tool being used to
simplify the availability of the commits to the main checkout.
# Porting a Project
When converting a project, if there are any local patches, a project should be
created [on GitLab](https://gitlab.kitware.com/third-party) to track it. If
the upstream project does not use Git, it should be imported into Git (there
may be existing conversions available on Github already). The project's
description should indicate where the source repository lives.
Once a mirror of the project is created, a branch named `for/foo` should be
created where patches for the `foo` project will be applied (i.e., `for/vtk`
for VTK's patches to the project). Usually, changes to the build system, the
source code for mangling, the addition of `.gitattributes` files, and other
changes belong here. Functional changes should be submitted upstream (but may
still be tracked so that they may be used).
Making the initial import involves filling out the project's `update.sh`
script in its directory. The [update-common.sh](update-common.sh) script
describes what is necessary, but in a nutshell, it is basically metadata such
as the name of the project and where it goes in the importing project.
The most important bit is the `extract_source` function which should subset
the repository. If all that needs to be done is to extract the files given in
the `paths` variable (described in the `update-common.sh` script), the
`git_archive` function may be used if the `git archive` tool generates a
suitable subset.
Also add an entry to [imported.md](imported.md) for the project.
# Process
The basic process involves a second branch where the third party project's
changes are tracked. This branch has a commit for each time it has been
updated and is stripped to only contain the relevant parts (no unit tests,
documentation, etc.). This branch is then merged into the main branch as a
subdirectory using the `subtree` merge strategy.
Initial conversions will require a manual push by the maintainers since the
conversion involves a root commit which is not allowed under normal
circumstances. Please send an email to the mailing list asking for assistance
if necessary.
# Converted projects
* [jsoncpp](jsoncpp/update.sh)
* [kwiml](../Utilities/KWIML/update.sh)
* [kwsys](../Utilities/KWSys/update.sh)
* [metaio](../Utilities/MetaIO/update.sh)
* [png](png/update.sh)
* [zlib](zlib/update.sh)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment