Skip to content

Conversation

@ulahello
Copy link

@ulahello ulahello commented Dec 1, 2025

Fixes #1931.

The description key from alire.toml is now copied into the generated crate configuration files.

TODOs

  • Properly escape description strings before placing them in Ada/GPR/C string literals
  • look into CI failure
PR creation checklist
  • A test is included, if required by the changes.
  • doc/user-changes.md has been updated, if there are user-visible changes.
  • doc/catalog-format-spec.md has been updated, if applicable.
  • BREAKING.md has been updated for major changes in alr, minor/major in catalog format.

Fixes alire-project#1931.

WIP! Not sure if we should be properly escaping strings before
placing them in Ada/GPR/C literals.
@ulahello ulahello marked this pull request as draft December 1, 2025 04:31
@ulahello ulahello changed the title Ula/crate description in configs Add crate description to generated configs Dec 1, 2025
@ulahello ulahello force-pushed the ula/crate-description-in-configs branch from 797def6 to 72c11f4 Compare December 1, 2025 04:34
declare
Version_Str : constant String := Rel.Version.Image;

-- TODO(ula): not properly escaped for Ada, GPR, nor C. for
Copy link
Member

Choose a reason for hiding this comment

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

@ulahello This is a good addition but the TODO must be addressed.

Copy link
Author

@ulahello ulahello Dec 18, 2025

Choose a reason for hiding this comment

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

Thanks for taking a look, I'll see if there's existing crates that do this.
edit: the alternative is of course writing it by hand, but I'd want to take a look at the relevant specs to make sure it's correct.

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.

Add crate description to generated configuration (feature request)

2 participants