Updated configuration docs and added 1.x -> 2.x migration doc#1403
Updated configuration docs and added 1.x -> 2.x migration doc#1403stevenengler merged 4 commits intoshadow:devfrom
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #1403 +/- ##
=======================================
Coverage 54.11% 54.12%
=======================================
Files 138 138
Lines 20438 20438
Branches 5164 5164
=======================================
+ Hits 11061 11062 +1
+ Misses 6463 6462 -1
Partials 2914 2914
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
| When encountering a tag/attribute that is not supported by the new format, these scripts will either: | ||
|
|
||
| 1. Copy it to the new file anyways. When attempting to use this new file with Shadow, Shadow will raise an error for this unexpected field. | ||
| 2. Ignore it and output a warning. |
There was a problem hiding this comment.
What determines which action is taken? Is 2. only for "whitelisted" attributes that we've deemed safe to drop? Or is it controlled by a command-line argument to the conversion script? Or...?
There was a problem hiding this comment.
Yeah, the ones that are dropped are ones that we should be able to drop (such as the preload attribute since Shadow now finds the shim automatically), or options that don't have anywhere to go in the new format (such as the plugin startsymbol option since we removed the plugin list). Another example is the topology graph prefer_direct_paths attribute which was moved to the shadow config file. If you convert only the topology it removes the attribute and gives a warning, but if you convert a shadow config that includes an inline topology, it automatically moves the attribute to the shadow config instead.
So the actual rules are kind of messy, which is why I added the comment "These scripts are intended to aid in converting to the new formats, and you should manually compare the original file to the new converted file to make sure it includes all of the options you expect". I don't expect these scripts to be used very often so hopefully this isn't a big deal.
No description provided.