toland/qlmarkdown

Discount submodule

tarwich opened this issue ยท 4 comments

Currently updating discount dirties up the tree pretty badly. Can we either change it to be a real submodule (now that git submodules are friendlier) or add it to the .gitignore?

Please +1 ๐Ÿ‘ if you agree. I'm hoping to generate conversation that will eventually result in cleaning up the git status output.

@toland I'm very curious if you still stand by your original idea of making it a fake submodule.

The original version of QLMarkdown used John Gruber's Perl script for rendering. Discount was a contribution from a community member. I think there was a reason for checking the Discount code into the repo, but honestly it was 5 years ago and I don't really remember. I have no objection to a submodule.

Converted to a submodule. The nice thing about submodules (and the bad thing depending on pov) is that they will stick at a particular hash. So if the submodule you're pointing to updates, then you won't get the updates until you choose to. Therefore, if the submodule's updates break your code, then you're safe, because it doesn't auto-update.

Unfortunately in order to prevent conflicts I was forced up make the updates in master instead of making them in a branch that could have been tested. sorry about that. If you try it out and don't like it, then just let me know and I'll revert it.

I'm working on getting everything to compile without a hitch, and there are still issues + the readme needs updated ๐Ÿ˜“. Currently the update.sh script should checkout the submodule, but in order to do it manually, you just run:

git submodule update --init

Looks good to me.

Seems working without too much hate so far. Closing