LUDOC-297 protocol: Update protocol document

[doc/protocol.git] / struct_llog_log_hdr.txt

diff --git a/struct_llog_log_hdr.txt b/struct_llog_log_hdr.txt
index 22ea437..ab9b7bd 100644 (file)
--- a/struct_llog_log_hdr.txt
+++ b/struct_llog_log_hdr.txt
@@ -39,6 +39,9 @@ begins with an 'llog_rec_hdr' and ends with an 'llog_rec_tail'.
 
 
 The lgd_llh_flags are:
+
+.LLog Flags
+****
 [source,c]
 ----
 enum llog_flag {
@@ -47,10 +50,11 @@ enum llog_flag {
        LLOG_F_IS_PLAIN         = 0x4,
 };
 ----
+****
 
-LLog Record Header
-^^^^^^^^^^^^^^^^^^
+.LLog Record Header
 [[struct-llog-rec-hdr]]
+****
 [source,c]
 ----
 struct llog_rec_hdr {
@@ -60,6 +64,7 @@ struct llog_rec_hdr {
        __u32   lrh_id;
 };
 ----
+****
 
 The 'llog_rec_hdr' is at the start of each llog record and describes
 the log record.  'lrh_len' holds the record size in bytes, including
@@ -69,6 +74,8 @@ can be used to determine the offset within the llog file when searching
 for an arbitrary record within the file. 'lrh_type' describes the type
 of data stored in this record.
 
+.LLog Operation Type
+****
 [source,c]
 ----
 enum llog_op_type {
@@ -88,10 +95,11 @@ enum llog_op_type {
        LLOG_LOGID_MAGIC        = LLOG_OP_MAGIC | 0x4553b,
 };
 ----
+****
 
-LLog Record Tail
-^^^^^^^^^^^^^^^^
+.LLog Record Tail
 [[struct-llog-rec-tail]]
+****
 [source,c]
 ----
 struct llog_rec_tail {
@@ -99,6 +107,7 @@ struct llog_rec_tail {
        __u32   lrt_index;
 };
 ----
+****
 
 The 'llog_rec_tail' is at the end of each llog record.  The 'lrt_len'
 and 'lrt_index' fields must be the same as 'lrh_len' and 'lrh_index'