From 992eac9c0490c41264fc87b113b32aaf046a4975 Mon Sep 17 00:00:00 2001 From: Frank Galligan Date: Wed, 4 Oct 2017 16:26:27 -0700 Subject: [PATCH] A few spec changes. --- docs/spec/04.00.00.conventions.md | 12 ++++++++++-- docs/spec/edgebreaker.decoder.md | 6 +++--- docs/spec/variable.descriptions.md | 2 +- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/spec/04.00.00.conventions.md b/docs/spec/04.00.00.conventions.md index 230bb66..d68b99e 100644 --- a/docs/spec/04.00.00.conventions.md +++ b/docs/spec/04.00.00.conventions.md @@ -47,14 +47,22 @@ section is the header. The second section contains the metadata. This section is * When bit reading is finished it will always pad the read to the current byte. +* I16, UI16, I32, UI32, I64, UI64, and Float values must be little endian. + * varUI32 and varUI64 types must be decoded by the LEB128() function. -* varUI32 can represent vaules in the range 0 to 2^32 - 1. +* varUI32 can represent values in the range 0 to 2^32 - 1. * E.g. 0x10000000 will be stored using 5 bytes. -* varUI64 can represent vaules in the range 0 to 2^64 - 1. +* varUI64 can represent values in the range 0 to 2^64 - 1. * E.g. 0x100000000000000 will be stored using 9 bytes. +* Metadata keys per metadata element must be unique. + +* att_metadata_id values must be unique. + +* All values of att_metadata_id must equal a value stored in att_dec_unique_id. + ### General Conventions diff --git a/docs/spec/edgebreaker.decoder.md b/docs/spec/edgebreaker.decoder.md index 0ff6b3f..3670cdb 100644 --- a/docs/spec/edgebreaker.decoder.md +++ b/docs/spec/edgebreaker.decoder.md @@ -21,12 +21,12 @@ void ParseEdgebreakerConnectivityData() { ~~~~~ void ParseTopologySplitEvents() { - num_topologoy_splits varUI32 - for (i = 0; i < num_topologoy_splits; ++i) { + num_topology_splits varUI32 + for (i = 0; i < num_topology_splits; ++i) { source_id_delta[i] varUI32 split_id_delta[i] varUI32 } - for (i = 0; i < num_topologoy_splits; ++i) { + for (i = 0; i < num_topology_splits; ++i) { split_edge_bit[i] f[1] source_edge_bit[i] f[1] } diff --git a/docs/spec/variable.descriptions.md b/docs/spec/variable.descriptions.md index 19171ed..22fba0e 100644 --- a/docs/spec/variable.descriptions.md +++ b/docs/spec/variable.descriptions.md @@ -120,7 +120,7 @@ * Number of encoded EdgeBreaker split symbols * encoded_connectivity_size * Size of encoded connectivity data in bytes -* num_topologoy_splits +* num_topology_splits * source_id_delta * Array of delta encoded source symbol ids * split_id_delta