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

add documentation #43

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Conversation

jimy-byerley
Copy link

Hello everyone, thanks for having wrapped the etherlab kernel module !

I'm starting this PR to add rust documentation to the crate. My first motivation is to have at least some description so I can easier use that crate in a project of mine, so my documentation efforts will be driven by my specific need. The description I will write might eventually be oriented for my use when my understanding is not that good, so I will try to avoid this.

For now I only documented Master, Domain, SlaveConfig by copying the descriptions from the functions of etherlab's C library

@birkenfeld
Copy link
Member

Thanks for the PR!

The issue I see here is that by copying from the GPL-licensed Etherlab implementation verbatim, we would have to relicense this crate or be in violation of the GPL.

Since I'm not a lawyer, I'm not sure how much the wording would need to differ to avoid this issue; this is the main reason #8 is still open.

@jimy-byerley
Copy link
Author

I'm not a lawyer either, but it seems we are in quite a dumb situation, there is not thousands of clear and concise ways of saying the same things. Does the license really apply on the the comments in the code ?
Maybe I can tune those comments to have some different sentences than the original, but a dumb work it is 😓

@jimy-byerley jimy-byerley marked this pull request as draft April 12, 2023 20:24
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.

2 participants