Skip to content

mdbook-html: Account for licenses of bundled JavaScript libraries and artwork #3144

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.

Sign up for GitHub

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

Open
decathorpe wants to merge 2 commits into
base: main
Choose a base branch
from
+488 −1
Open

mdbook-html: Account for licenses of bundled JavaScript libraries and artwork #3144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7808bdc
Add license texts for bundled JavaScript libraries and artwork
decathorpe Jun 24, 2026
921a74e
Update mdbook-html license to account for included code and content
decathorpe Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/mdbook-html/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "mdbook-html"
version = "0.5.3"
description = "mdBook HTML renderer"
edition.workspace = true
license.workspace = true
license = "MPL-2.0 AND Apache-2.0 AND BSD-3-Clause AND CC-BY-4.0 AND MIT AND OFL-1.1"

@GuillaumeGomez GuillaumeGomez Sep 8, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wonder if the license field is for the whole crate or for the rust code. And even worse: if we don't enable the "editable codeblock" feature, some of the licenses are not in use.

View changes since the review

@decathorpe decathorpe Sep 8, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I wonder if the license field is for the whole crate or for the rust code.

Right, I have not ever seen a conclusive decision about this - but since this is the license string that is prominently displayed in various places (like the crates.io page) ... 🤷🏼‍♂️

For what it's worth, the legal guidance we have received from Red Hat lawyers for Fedora packaging is that our license metadata should just enumerate the licenses of everything that's included in a package.

And even worse: if we don't enable the "editable codeblock" feature, some of the licenses are not in use.

Barring conditional crate metadata ("if feature foo is enabled then license this else that") this is not expressible. Additionally, this seems to be related to the kind of book content that mdbook generates at runtime - but that has no bearing on whether this content (JavaScript, etc.) gets compiled / statically embedded into the mdbook executable, which happens unconditionally.

@GuillaumeGomez GuillaumeGomez Sep 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah no clue.

@decathorpe decathorpe Sep 10, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Including license texts for all bundled components should be the uncontroversial part here though, I can drop changing the package.license metadata for the mdbook-html crate from this PR for now, if that helps?

@GuillaumeGomez GuillaumeGomez Sep 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I pinged someone who might know more about, so let's just wait for their input. Sorry for they delay here, it's the kind of things you don't want to mess up so rather than making you do more changes for nothing, better to wait for their input.

repository.workspace = true
rust-version.workspace = true

Expand Down
Loading
Loading