Skip to content

Add [provides.instance] to the StarMap listing #44

Description

@Maximilian-Nesslauer

Once RFC 0049 (content-manager-design#49) is accepted and the schema validates the table, listings/StarMap.toml gets two lines under [provides]:

[provides.instance]
flag = "-InstancePath"
variable = "STARMAP_INSTANCE_PATH"

Why both keys

RFC 0049 records what the StarMap source does.
DocumentsPathPatches.TryGetOverride reads -InstancePath from the raw process arguments, with the next argument as the path, and falls back to STARMAP_INSTANCE_PATH.
ModLibraryPatches.BeforePrepareAll restarts the loader with only --restarted after new mods were enabled, so the variable is what keeps the instance across that restart.
A manager that reads the table passes both.

Who opens the pull request

The listing binds to StarMapLoader/StarMap, so a pull request from @KlaasWhite verifies against that authority and merges itself once the checks pass.
A pull request from anyone else waits for a steward, which is fine too.
One pull request, one document, nothing else in it.

After it merges

The examples/ copy in the design repo is synced in a follow-up pull request there, the way #47 did it.

Tests

The pull request checks.

Depends on

The validation issue and content-manager-design#49.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:publishinglisting and release flowsblockedwaiting on another issue or on someone else

    Type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions