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

Documentation of export is misleading #77

Open
JasonGross opened this issue Oct 7, 2022 · 2 comments
Open

Documentation of export is misleading #77

JasonGross opened this issue Oct 7, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@JasonGross
Copy link
Member

"space-separated list of variables" with an example of 'OPAMWITHTEST' suggests to me that 'foo' 'bar' would be valid, but it's a very unhelpful syntax error:
image
https://github.com/mit-plv/fiat-crypto/actions/runs/3206456319/workflow

@erikmd
Copy link
Member

erikmd commented Oct 14, 2022

Hi @JasonGross, the error you raise is really a regular YAML error, I wasn't expecting that the current documentation was so misleading.
Actually, the export field should be a YAML string, containing a list (in informal sense) of space-separated shell variables.
No need for ' around each shell variable, because anyway, a variable name cannot contain a space.
So here, one can use export: "SKIP_VALIDATE COQCHKEXTRAFLAGS EXTRA_GH_REPORTIFY"

→ Do you think that the following line would be clearer in the doc?

      export: 'OPAMWITHTEST OPAMWITHDOC'  # space-separated list of variables

@erikmd erikmd added the documentation Improvements or additions to documentation label Oct 14, 2022
@JasonGross
Copy link
Member Author

Yes, I think that's a better example

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants