Working with Git Submodules and Master Files

Having trouble installing <oXygen/>? Got a bug to report? Post it all here.
jhanna
Posts: 11
Joined: Mon Aug 17, 2020 6:29 pm

Working with Git Submodules and Master Files

Post by jhanna » Thu Sep 17, 2020 11:14 pm

Hello,

I've noticed that for a project which contains a Git submodule and a Master File that links will not update if a file in the submodule is moved or renamed after a pull update. I'm guessing this is the expected behavior since the files were updated automatically outside of the Project View in Oxygen.

Am I correct that this is the expected behavior or is there something that I could do differently so that links automatically update? Is it generally recommended that files in a submodule should not be removed or renamed to avoid broken links? Maybe this is a good case where keys should be used instead of direct links?

Thanks,
Jonathan

sorin_carbunaru
Posts: 328
Joined: Mon May 09, 2016 9:37 am

Re: Working with Git Submodules and Master Files

Post by sorin_carbunaru » Fri Sep 18, 2020 9:31 am

Hello Jonathan,

Yes, this is indeed the expected behavior because, as you suspected, references are updated only if the rename/move operations are performed inside Oxygen, in the Project side-view.
Is it generally recommended that files in a submodule should not be removed or renamed to avoid broken links?
Well, we don't have much experience with Git submodules, therefore I cannot give you any recommendations. But if you want to make sure you don't have broken references, you can use the DITA map completeness check from time to time (https://www.oxygenxml.com/doc/versions/ ... idate.html).
Maybe this is a good case where keys should be used instead of direct links?
Yes, I would say using keys should make life easier. For example, if you rename a file, you would only need to update the key instead of updating all the direct references.

All the best wishes,
Sorin Carbunaru
Oxygen XML Editor

Post Reply