Skip to content

Add source to metadata#572

Open
drbh wants to merge 4 commits into
mainfrom
add-source-to-metadata
Open

Add source to metadata#572
drbh wants to merge 4 commits into
mainfrom
add-source-to-metadata

Conversation

@drbh
Copy link
Copy Markdown
Collaborator

@drbh drbh commented May 20, 2026

This PR adds a new optional source attribute to the metadata struct, this source is different than upstream since it is intended to point to the kernel builder compliant source related to the kernel. This distinction is important since the upstream may not originally be formatted in a way that the kernel-builder can compile - yet we want to be able to indicate the original code, and the code used to compile the kernel.

Note this PR also adds a step to validate the upstream and the source fields to be git urls

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Copy Markdown
Member

@danieldk danieldk left a comment

Choose a reason for hiding this comment

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

Nice!!! Added some comments on the docs.

Comment on lines +193 to +197
- `upstream`: URL of the original upstream repository where the kernel
source code comes from.
- `source`: URL of the kernel-builder formatted source repository. This
repository must contain a `build.toml` and `flake.nix` so that it can be
pulled and built with the kernel builder.
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.

In both cases, I think we should say something about the format. Should this be a URL that can be passed directly to git? What about Git over SSH?

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.

Now saw GitUrl below, so I think good to mention here that these should be Git-compatible (passable to git clone).

Comment on lines +74 to +77
- `upstream` (`str`, optional): URL of the original upstream repository
where the kernel source code comes from.
- `source` (`str`, optional): URL of the kernel-builder formatted source
repository (must contain `build.toml` and `flake.nix`).
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.

See above.

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.

3 participants