Update multiplatform-ktor-sqldelight.md #250
Conversation
Extended the section on sqlite linker flags. While I understand this is an overview for simplicity, this section is showing up as the "official solution", and there are real reasons you wouldn't want a dynamic framework. OK if you don't want to complicate the docs, but had to try :)
|
|
||
| The Kotlin Multiplatform wizard generates projects set up for static linking of iOS frameworks. | ||
| To use the SQLDelight library, allow the iOS framework to link dynamically. | ||
| The pros and cons of static vs dynamic linking are only important for production apps. To make linking simple for now, link your framework dynamically. |
There was a problem hiding this comment.
These docs are a bit out of date for another reason: in recent versions of KMP, dynamic linking is already the default. So it makes no sense to have a section titled "Turn off static linking".
There was a problem hiding this comment.
What do you consider "recent versions of KMP"? Most of the samples in the docs are based on the KMP wizard, and the latest project generated there still has isStatic = true in that section.
There was a problem hiding this comment.
I'm talking about the default for the Kotlin gradle plugin, not the KMP wizard.
There was a problem hiding this comment.
I see. The section is explicitly written in the context of the tutorial and the wizard, so I don't think there should be any confusion here.
It was pointed out to us that one can remove the isStatic field rather than set it to false since this is the default value, and maybe that's what we should advise here. I think we opted for clarity last time, but I'm not so sure now.
There was a problem hiding this comment.
Ah, given this is written in the context of the wizard which sets it to true, it makes sense.
|
@kpgalligan I started to review this, but I think it's easier on us and the reader just to ask them to add the linker flag. The production considerations sound like a tease without actual deeper dive to refer to :) I'm closing this PR, but please tell me if I missed something in the one I made: #253 |
Extended the section on sqlite linker flags. While I understand this is an overview for simplicity, this section is showing up as the "official solution", and there are real reasons you wouldn't want a dynamic framework.
OK if you don't want to complicate the docs, but had to try :)