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

Plugins: Improve c plugin (doc, tests, refactor) #4979

Merged
merged 4 commits into from
Jul 28, 2023

Conversation

flo91
Copy link
Collaborator

@flo91 flo91 commented Jul 12, 2023

  • some small refactoring (e.g. remove unnecessary dups, reduce scope of variables)
  • add code documentation (Doxygen)
  • extended README.md
  • add unit tests

Basics

  • Short descriptions of your changes are in the release notes
    (added as entry in doc/news/_preparation_next_release.md which contains _(my name)_)
    Please always add them to the release notes.
  • Details of what you changed are in commit messages
    (first line should have module: short statement syntax)
  • References to issues, e.g. close #X, are in the commit messages.
  • The buildservers are happy. If not, fix in this order:
    • add a line in doc/news/_preparation_next_release.md
    • reformat the code with scripts/dev/reformat-all
    • make all unit tests pass
    • fix all memleaks
    • fix the CI itself (or rebase if already fixed)
  • The PR is rebased with current master.

Checklist

  • I added unit tests for my code
  • I fully described what my PR does in the documentation
    (not in the PR description)
  • I fixed all affected documentation (see Documentation Guidelines)
  • I fixed all affected decisions (see Decision Process)
  • I added code comments, logging, and assertions as appropriate (see Coding Guidelines)
  • I updated all meta data (e.g. README.md of plugins and METADATA.ini)
  • I mentioned every code not directly written by me in reuse syntax

Review

Labels

  • Add the "work in progress" label if you do not want the PR to be reviewed yet.
  • Add the "ready to merge" label if everything is done and no further pushes are planned by you.

- some small refactoring (e.g. remove unnecessary dups, reduce scope of variables)
- add code documentation (Doxygen)
- extended README.md
- add unit tests
@atmaxinger
Copy link
Contributor

In what state is this? Do you think this should also be part of the v0.11 release?

@flo91
Copy link
Collaborator Author

flo91 commented Jul 22, 2023

This PR is basically finished and ready for reviews.
If the reviewers approve the changes, I don't see a reason why we shouldn't include it in v0.11.

Copy link
Contributor

@markus2330 markus2330 left a comment

Choose a reason for hiding this comment

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

Great, yes, let us take this in. Shell recorder tests would have been nice.

src/plugins/c/README.md Outdated Show resolved Hide resolved
Comment on lines +23 to +24
So one use case is to extract a part of the KDB and copy the generated code
to create the exported part of the KDB programmatically, e.g. for another Elektra installation.
Copy link
Contributor

Choose a reason for hiding this comment

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

one line per sentence according to documentation guidelines.

src/plugins/c/c.c Outdated Show resolved Hide resolved
Co-authored-by: Markus Raab <markus2330@users.noreply.github.com>
@atmaxinger
Copy link
Contributor

Great work!

@atmaxinger
Copy link
Contributor

jenkins build libelektra please

2 similar comments
@atmaxinger
Copy link
Contributor

jenkins build libelektra please

@atmaxinger
Copy link
Contributor

jenkins build libelektra please

@atmaxinger atmaxinger merged commit 76276dd into ElektraInitiative:master Jul 28, 2023
14 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants