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

crush: API documentation #13205

Merged
merged 1 commit into from Jan 31, 2017

Conversation

Projects
None yet
3 participants
crush: API documentation
Signed-off-by: Loic Dachary <loic@dachary.org>

@ghost ghost added core documentation labels Jan 31, 2017

@ghost ghost requested a review from liewegas Jan 31, 2017

@liewegas

This comment has been minimized.

Member

liewegas commented Jan 31, 2017

Oops, one thing I should have noticed before: currently these files (crush.h, mapper.[ch]) are easy to sync up with the kernel by copying into the tree and looking for any diffs with git gui (or similar). The inline doxygen will make that a bit harder, and I imagine the kernel doesn't want doxygen in the tree. Or maybe they don't care since we're the maintainers... @idryomov do you think it matters? Worst case we can try to avoid doxygen comments on the same line so that it's easy to exclude them. But hopefully we can just dump them in the kernel too?

@ghost

This comment has been minimized.

ghost commented Jan 31, 2017

Or we can move the doxygen comments in a separate file and not touch the *.[ch] files at all. When we discussed with @adamemerson about various options, it made most sense to keep the documentation close to the functions to help keep it in sync. Either way it's not a blocker :-)

@idryomov

This comment has been minimized.

Contributor

idryomov commented Jan 31, 2017

I'd rather not throw a wrench into the documentation effort. A separate file definitely makes less sense.
I'm fine with pulling it into the kernel -- if it ends up causing problems, stripping everything (including inline comments) should be fairly easy.

@ghost

This comment has been minimized.

ghost commented Jan 31, 2017

@idryomov cool :-)

@liewegas liewegas merged commit 44c4120 into ceph:master Jan 31, 2017

3 checks passed

Signed-off-by all commits in this PR are signed
Details
Unmodifed Submodules submodules for project are unmodified
Details
default Build finished.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment