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

Meta-issue: Highlevel Code-generation #2680

Open
kodebach opened this issue May 8, 2019 · 4 comments

Comments

Projects
None yet
2 participants
@kodebach
Copy link
Contributor

commented May 8, 2019

This is a list of open tasks related to the highlevel code-generation:

  • Documentation of code-generation framework
  • Documentation of highlevel (renamed from elektra) template link
  • Add exported CMake function for invoking code generation link
  • Make -F option available for other commands (#2677) and wrap code needed link
  • Fully implement or remove APIs related to contextual values
  • Maybe use more real-worldy example instead of tree
  • Improve documentation of examples
  • Write tutorial for using code-generation in an application
  • Minor issues from code reviews:
    • Rename elektra template to highlevel link
    • Remove static helpKey from template link
    • (If possible) convert examples READMEs to shell recorder link
    • Fix typos link1 link2 link3
    • Improve README script link
    • Remove unnecessary macro link
    • Add mustache library license to LICENSE.md link

I hope I've got everything from #2498

@kodebach kodebach self-assigned this May 8, 2019

@kodebach kodebach referenced this issue May 8, 2019

Merged

Highlevel codegen #2498

5 of 9 tasks complete
@markus2330

This comment has been minimized.

Copy link
Contributor

commented May 9, 2019

Thank you for creating the issue!

@kodebach

This comment has been minimized.

Copy link
Contributor Author

commented May 14, 2019

Right now the code-generation creates files which are marked as BSD-licensed.

/**
* @file
*
* @brief
*
* @copyright BSD License (see doc/LICENSE.md or https://www.libelektra.org)
*/

Should that stay, or should only the template be under BSD license?

@markus2330

This comment has been minimized.

Copy link
Contributor

commented May 14, 2019

Actually we could make them public domain. Then there should be definitely no problem for other projects which might have BSD-incompatible licenses (cannot mix their own code with BSD licensed code. I do not know if such a license exists, though.).

@kodebach

This comment has been minimized.

Copy link
Contributor Author

commented May 14, 2019

I now changed the templates (not pushed yet), so that the BSD zero clause license applies to the templates. This should ensure that the generated files can be used in anyway the user wants to. The generated files will also contain this license. As far as I understand, this should allow users to use the code in any project. As 0BSD doesn't even require that the license is retained.

I didn't make the files public domain, because that seems to be hard to do right.

@kodebach kodebach referenced this issue May 20, 2019

Open

Highlevel codegen updates #2707

4 of 9 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.