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

doc/dev: add a brief guide to serialization #20131

Merged
merged 1 commit into from Mar 5, 2018
Merged

Conversation

jcsp
Copy link
Contributor

@jcsp jcsp commented Jan 26, 2018

Contributors encounter this pretty soon when trying
to add any feature to Ceph, so I'd like a central place
to point them to.

Ignoring feature bits etc for this simple example.

Signed-off-by: John Spray john.spray@redhat.com

if (struct_v >= 2) {
::decode(member3, bl);
}
DECODE_FINISH(bl);
Copy link
Contributor

@tchaikov tchaikov Jan 26, 2018

Choose a reason for hiding this comment

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

it's encouraged to support the new-style denc. see DENC(),DENC_START() and DENC_FINISH(). i can add a section for it once this change gets merged in.

Copy link
Contributor

@tchaikov tchaikov left a comment

Choose a reason for hiding this comment

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

great start. we can augment this doc with more stuff like feature bits, and new style denc and its traits. but we can leave them for another PR(s).

::
class AcmeClass
{
int member1;
Copy link
Contributor

Choose a reason for hiding this comment

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

For some reason, we're getting the following build error on this line:

Warning, treated as error:
/home/jenkins-build/build/workspace/ceph-pr-docs/doc/dev/encoding.rst:61:Unexpected indentation.

Contributors encounter this pretty soon when trying
to add any feature to Ceph, so I'd like a central place
to point them to.

Ignoring feature bits etc for this simple example.

Signed-off-by: John Spray <john.spray@redhat.com>
@jcsp jcsp merged commit 86d7f3f into ceph:master Mar 5, 2018
@jcsp jcsp deleted the wip-doc-encoding branch March 5, 2018 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants