Skip to content
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.

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

Missing documentation for MetaData, PackageSource, Architecture & UseFlags files #20

Open
Nuc1eoN opened this issue Oct 30, 2021 · 0 comments

Comments

@Nuc1eoN
Copy link
Member

Nuc1eoN commented Oct 30, 2021

I have noticed that some programs under /Programs/*/Resources/ hold files such as MetaData and PackageSource, Architecture, UseFlags, which are totally undocumented.

There might be more of such files which I might have missed.

And example would be under /Program/Curl/Current/Resources/*

Those files do not appear in the corresponding recipes of the package, so it appears that Compile is creating those files under certain undocumented conditions during installation.


I could only find a brief mention of the Architecture file in Runners documentation https://github.com/gobolinux/Documentation/wiki/Runner

And a brief mention of the UseFlags file at the very bottom of https://github.com/gobolinux/Documentation/wiki/Use-flags#use-flags-in-recipes


I know one can probably derive the meaning of those files by their names/contents, but I do think that they should be properly documented nonetheless to avoid confusion.

@lucasvr if you know what those files mean, why, what for, and when they are created would you be so kind and add some documentation about it?

If I am not mistaken they should be documented under https://github.com/gobolinux/Documentation/wiki/Recipe-Format-Specification#resources

Also they should probably be listed in the packed recipe file layout tree https://github.com/gobolinux/Documentation/wiki/Recipe-Format-Specification#file-layout

@Nuc1eoN Nuc1eoN changed the title Missing documentation for MetaData, PackageSource, Architecure & UseFlags files Missing documentation for MetaData, PackageSource, Architecture & UseFlags files Oct 30, 2021
@Nuc1eoN Nuc1eoN pinned this issue Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant