fix(file-list): correct recursive file listing #456
Merged
Conversation
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
When there are models that follow a recursive structure. For example: ``` something.net.nml -> ./cells/cell.nml -> ./channels/channel.nml ``` When processing the cell.nml file, we must do it relative to its location, not relative to the root file (something.net.nml) so that the paths are correct in the final list of files included in the model. We do this by making sure that when recursing through the list, we pass the location of the "new" rootfile, and when we append the processed file to the file list, we include its "rootdir", which would be relevant to the "main" rootfile.
Scenario 1: Function is called from the directory where the "rootfile" lives. This is simple, as all the files will have includes relative to this directory. However, we do need to handle recursion because models and includes can be split into any numbers of folders/levels. Scenario 2: Function is not called from the directory where the "rootfile" lives. The directory is specified as the "rootdir". Here, we need to append the rootdir to all the includes also so that they can be correctly found. This case is not suggested, especially for archiving.
We now move all the folder bits to the rootdir, and keep the rootfile only as the name. This simplifies further processing, especially passing the folders to the recursively included files.
sanjayankur31
force-pushed
the
fix-filelist
branch
from
833cf4f to
33dbeb2
Compare
[skip ci]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When there are models that follow a recursive structure. For example:
When processing the cell.nml file, we must do it relative to its location, not relative to the root file (something.net.nml) so that the paths are correct in the final list of files included in the model.
We do this by making sure that when recursing through the list, we pass the location of the "new" rootfile, and when we append the processed file to the file list, we include its "rootdir", which would be relevant to the "main" rootfile.