taichi-dev
Put examples into a new repo and include it as a submodule
Hi, the current examples folder is hidden far from the top directory, shall we make it visible as a top-level directory? @feisuzhu WDYT?
Maybe an easier solution is to add a soft link at the top level in the existing repo?
Maybe an easier solution is to add a soft link at the top level in the existing repo?
Symlinks can be problematic on Windows. Git does not use symlinks unless configured core.symlinks=true.
I'm proposing below change:
- Spin off examples directory to a dedicated repo.
- Put examples repo as submodule at top level in taichi repo.
- Put a symlink at original location points to top-level examples directory.
This solution
- Improved examples visibility as intended.
- release-tests-runner now can treat examples the same as others (DiffTaichi/QuanTaichi/etc.).
- The symlink serves as an indicator for 'examples actually should be here'.(IIRC it's @ailzhang 's wish?)
- URLs in docs still have to be changed since Github will not chase symlinks.
My 2 cents: The biggest concern I have with submodules is that it somewhat complicates the dependency management. The repo separation would increase the likelihood for these two repos to go out of sync, and for devs to be dealing with problems like "Taichi@commit-X cannot support TaichiExamples@commit-Y". From my past experience, submodules are mostly useful when used as a dependency, i.e. we have a necessity to pin this module at a specific version, and roll it up from time to time.
That said, we are maintaining several repos this way, so I don't hold strong opinions on this. But I am curious about why we cannot move examples/ to the top level?
But I am curious about why we cannot move examples/ to the top level?
I feel like one major reason is that we don't wish to invalidate existing links to python/taichi/examples/simulation/X.py :-)
But I am curious about why we cannot move examples/ to the top level?
I feel like one major reason is that we don't wish to invalidate existing links to
python/taichi/examples/simulation/X.py:-)
Hmm, I see. From @feisuzhu 's answer, URLs still has to be changed, though... And I share the same worry about symlink supports in Git.
To give a bit context on why we moved examples from top level into python dir:
When we had examples in top level, everytime you build taichi it copies the examples folder into python/taichi folder so you'll have two copies. Developers get confused where these examples come from, and they'll have to be aware that changing the examples in top level in develop mode won't update the real script getting called in ti example.
I feel like there might be a way that by changing setup.py we can keep examples in top level, but avoid the explicit copy into python/taichi folder when packaging. @feisuzhu wdyt?
W.r.t invalid links, IMHO we can't avoid it if we want examples in top level and not using symlinks. Probably it's good to start using permanent links for code pointers in the future?
W.r.t invalid links, IMHO we can't avoid it if we want examples in top level and not using symlinks. Probably it's good to start using permanent links for code pointers in the future?
I feel like we have to update the links anyway. Otherwise it's broken links vs stale links :joy: