Skip to content

Various Improvements and Feedback (DevSkiller - Reuben Roessler)#14

Open
rroessler wants to merge 1 commit intocanonical:mainfrom
rroessler:main
Open

Various Improvements and Feedback (DevSkiller - Reuben Roessler)#14
rroessler wants to merge 1 commit intocanonical:mainfrom
rroessler:main

Conversation

@rroessler
Copy link
Copy Markdown

This PR proposes the following improvements:

  • Fixed styling to be consistent (recommend adding a style-guide in future)
  • Changed "die" to "sc_show_error_and_die" to be non-ambiguous.
  • Added appropriate "free" and "fclose" handling for the library.
  • Added "unrestricted" check for headers as they can have unsupported values.
  • Added documentation comments for the "seccomp.h" include.

Additionally, some feedback that I have regarding this library includes:

  • A ".gitignore" be provided since it has potential build outputs.
  • A style guide or formatter (such as clang-format) would improve code quality.
  • Adding a "README.md" would be useful for developers using this library publicly.
  • Some of the "seccomp.h" methods previously exited the process in an unconventional manner (eg: forgetting to free or fclose items). It would be prudent to simplify this process into the exposed methods so that all allocated data or opened files can be safely removed in the event of failures. Eg: Use an opaque pointer for necessary operations.
  • Add a contribution guide so streamline the process for bug-fixes, features and more.

- Fixed styling to be consistent (recommend adding a style-guide in future)
- Changed "die" to "sc_show_error_and_die" to be non-ambiguous.
- Added appropriate "free" and "fclose" handling for the library.
- Added "unrestricted" check for headers as they can have unsupported values.
- Added documentation comments for the "seccomp.h" include.
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.

1 participant