Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[build] Update katex submodule #1726

Merged
merged 1 commit into from
Feb 15, 2024
Merged

[build] Update katex submodule #1726

merged 1 commit into from
Feb 15, 2024

Conversation

sideshowbarker
Copy link
Member

@sideshowbarker sideshowbarker commented Feb 15, 2024

Without this update, running the build locally in my macOS environment fails with a bunch of errors containing the message “➤ YN0001: │ Error [ERR_STREAM_PREMATURE_CLOSE]: Premature close”.

@sideshowbarker sideshowbarker force-pushed the sideshowbarker/katex-update branch from 33db90f to 384499c Compare February 15, 2024 06:52
@sideshowbarker sideshowbarker changed the title Update katex submodule [build] Update katex submodule Feb 15, 2024
@rossberg
Copy link
Member

rossberg commented Feb 15, 2024

Isn't that a submodule? Looking at .gitmodules, was that even versioned?

I'm confused about the diff GH shows for this PR, which only contains the submodule directory. What actual repository file does the commit change?

@sideshowbarker
Copy link
Member Author

This is just changing the hash that git and GitHub store for the revision of the repo for the submodule.

That hash isn’t persistently stored in any files checked into the repo, but is instead just internal metadata that’s stored locally in the .git directory after you clone and init the submodule.

Isn't that a submodule?

It is, yeah

Looking at .gitmodules, was that even versioned?

I think .gitmodules never contains version information about submodules — it instead just contains the repo URL for the repo the submodule comes from, and the local path the submodule gets cloned into.

git submodule status is what I know of to get the submodule version info. Running that in the main branch shows this:

$ git submodule status
 e751278cff42fada16dba6df331fda52aaa90f73 document/core/util/katex (v0.13.0-316-ge751278c)

…and running it in environment with the change from this PR branch shows this:

$ git submodule status
 3d5de92fb0d0511ac64901bb60b5d46c5677eb28 document/core/util/katex (v0.13.0-537-g3d5de92f)

git stores that hash/version info locally in the .git directory. But it can also be seen from the GitHub web UI at https://github.com/WebAssembly/spec/tree/main/document/core/util for the main branch — which shows katex @ e751278 — while for this PR branch, https://github.com/WebAssembly/spec/tree/sideshowbarker/katex-update/document/core/util shows katex @ 3d5de92.

I'm confused about the diff GH shows for this PR, which only contains the submodule directory. What actual repository file does the commit change?

It just changes the hash that git and GitHub store for the revision of the repo for the submodule. I don’t know where GitHub stores it. As far as I know, https://github.com/WebAssembly/spec/tree/main/document/core/util is the place in the GitHub UI where that hash is exposed/observable.

Copy link
Member

@rossberg rossberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation. Obviously, I don't understand how git submodules work. :)

@rossberg rossberg merged commit 17cf849 into main Feb 15, 2024
4 checks passed
@rossberg rossberg deleted the sideshowbarker/katex-update branch February 15, 2024 09:07
@sideshowbarker
Copy link
Member Author

Thanks for the explanation. Obviously, I don't understand how git submodules work. :)

I can’t actually claim to understand how git submodules work either :D What I outlined in my comment above is pretty much the full extent of my knowledge on the subject…

rossberg pushed a commit that referenced this pull request Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants