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.

Sign up for GitHub

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

Jump to bottom

Improve documentation and comments on expects/unwraps #808

Closed
dianpopa opened this issue Jan 3, 2019 · 3 comments
Closed

Improve documentation and comments on expects/unwraps #808

dianpopa opened this issue Jan 3, 2019 · 3 comments
Labels
Priority: Low Indicates that an issue or pull request should be resolved behind issues or pull requests labelled ` Type: Documentation Indicates a need for improvements or additions to documentation

Comments

@dianpopa
Copy link
Contributor

dianpopa commented Jan 3, 2019

We need to clarify our use of unwraps and expects throughout the code (i.e. gracefully terminate program execution in case of invariant being violated).
@andreeaflorescu
Copy link
Member

One common usecase that we have to consider is dev/kvm not having the proper permissions.

@andreeaflorescu andreeaflorescu mentioned this issue Jan 10, 2019
Closed
@alexandruag alexandruag added the Priority: Medium Indicates than an issue or pull request should be resolved ahead of issues or pull requests labelled label Feb 15, 2019
@bbros-dev
Copy link
Contributor

bbros-dev commented Jun 25, 2020 •
edited
Loading

Specifically, the instruction to reset this after rebooting (does it need to be reset after a logout? To be confirmed) needs to go into the Getting Started.

It does not seem to be the case that the setfacl needs to be reset after each invocation of firecracker (see this comment).
However, my machine has had enough changes I'm not sure if that is true for a vanilla installation.

@alindima alindima added Priority: Low Indicates that an issue or pull request should be resolved behind issues or pull requests labelled ` and removed Priority: Medium Indicates than an issue or pull request should be resolved ahead of issues or pull requests labelled labels Feb 14, 2022
@alindima
Copy link
Contributor

Related to #593

@JonathanWoollett-Light JonathanWoollett-Light added Type: Documentation Indicates a need for improvements or additions to documentation and removed Documentation: Usage labels Mar 23, 2023
roypat added a commit to roypat/firecracker that referenced this issue May 20, 2024
@roypat
doc: Add CONTRIBUTING guideline about .unwrap() usage
ea07dd3 
Closes firecracker-microvm#808

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
@roypat roypat mentioned this issue May 20, 2024
Merged
9 tasks
roypat added a commit to roypat/firecracker that referenced this issue May 20, 2024
@roypat
doc: Add CONTRIBUTING guideline about .unwrap() usage
9de3bc4 
Clarifies that we want to avoid unwraping in favor of propagating
errors.

Closes firecracker-microvm#808

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
roypat added a commit to roypat/firecracker that referenced this issue May 20, 2024
@roypat
doc: Add CONTRIBUTING guideline about .unwrap() usage
abc3bde 
Clarifies that we want to avoid unwraping in favor of propagating
errors.

Closes firecracker-microvm#808

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
ShadowCurse pushed a commit to roypat/firecracker that referenced this issue May 23, 2024
@roypat @ShadowCurse
doc: Add CONTRIBUTING guideline about .unwrap() usage
3eddd50 
Clarifies that we want to avoid unwraping in favor of propagating
errors.

Closes firecracker-microvm#808

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Priority: Low Indicates that an issue or pull request should be resolved behind issues or pull requests labelled ` Type: Documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@alxiord @andreeaflorescu @dianpopa @alexandruag @alindima @JonathanWoollett-Light @bbros-dev