Skip to main content

Module notices

Module notices 

Source
Expand description

NOTICES.txt: the notices a package of a game owes for the works in it, written beside the game. shuyi web writes one into the web build (crate::web). It lists the crates compiled in (crates), the web shell’s files and the game’s own license texts (game_texts), then each license text once (write()).

It copies what the packages say and judges nothing: every license of an OR is listed, and a crate with no license file gets the standard text of each license it declares that this tool can write.

Structs§

EngineFile
A file of the engine’s that reaches a game’s package and isn’t a crate. Every one has its row in THIRD_PARTY_ASSETS.md (a test).
Text
A license or notice text.
Work
A work in the package, and its texts.

Enums§

Build
What a package is built for, as FILES says which carry a file.
Section
Which part of NOTICES.txt a work is listed in.

Constants§

FILE
The file’s name.
FILES
The engine’s files that aren’t crates, as data: the web shell’s vendored scripts, and the controller database gilrs compiles into native builds (which the crates’ walk misses, in a subfolder of its package).

Functions§

crates
The crates the package package of the workspace at root compiles in for triple with features (its own) turned on: its normal dependencies, all the way down, by cargo metadata. Dev- and build-dependencies don’t ship; the game’s own crates (workspace members outside the engine’s repository) are the game’s work, not a notice.
engine_files
The works of FILES that a build package carries whose crates are crates (the crates compiled in), apart from the web shell’s, which web lists with the shell.
engine_texts
The engine’s own texts, for its crates and its files.
game_texts
The game’s own license texts that notices names, each a work of its own read whole from the project at root.
write
Writes NOTICES.txt into dist for the game called title.