Commit eac5455a authored by unknown's avatar unknown

mach0data.ic, mach0data.h:

  Improve documentation of mach_*write_*compressed()
mtr0log.ic, mtr0log.h:
  Improve documentation of mlog_write_initial_log_record_fast()


innobase/include/mtr0log.h:
  Improve documentation of mlog_write_initial_log_record_fast()
innobase/include/mtr0log.ic:
  Improve documentation of mlog_write_initial_log_record_fast()
innobase/include/mach0data.h:
  Improve documentation of mach_*write_*compressed()
innobase/include/mach0data.ic:
  Improve documentation of mach_*write_*compressed()
parent 20985f3e
......@@ -89,7 +89,7 @@ mach_read_from_4(
/* out: ulint integer */
byte* b); /* in: pointer to four bytes */
/*************************************************************
Writes a ulint in a compressed form. */
Writes a ulint in a compressed form (1..5 bytes). */
UNIV_INLINE
ulint
mach_write_compressed(
......@@ -168,7 +168,7 @@ mach_read_from_8(
/* out: dulint integer */
byte* b); /* in: pointer to 8 bytes */
/*************************************************************
Writes a dulint in a compressed form. */
Writes a dulint in a compressed form (5..9 bytes). */
UNIV_INLINE
ulint
mach_dulint_write_compressed(
......@@ -193,7 +193,7 @@ mach_dulint_read_compressed(
/* out: read dulint */
byte* b); /* in: pointer to memory from where to read */
/*************************************************************
Writes a dulint in a compressed form. */
Writes a dulint in a compressed form (1..11 bytes). */
UNIV_INLINE
ulint
mach_dulint_write_much_compressed(
......
......@@ -366,7 +366,7 @@ mach_read_from_6(
}
/*************************************************************
Writes a dulint in a compressed form. */
Writes a dulint in a compressed form (5..9 bytes). */
UNIV_INLINE
ulint
mach_dulint_write_compressed(
......@@ -422,7 +422,7 @@ mach_dulint_read_compressed(
}
/*************************************************************
Writes a dulint in a compressed form. */
Writes a dulint in a compressed form (1..11 bytes). */
UNIV_INLINE
ulint
mach_dulint_write_much_compressed(
......
......@@ -108,7 +108,9 @@ mlog_close(
mtr_t* mtr, /* in: mtr */
byte* ptr); /* in: buffer space from ptr up was not used */
/************************************************************
Writes the initial part of a log record. */
Writes the initial part of a log record (3..11 bytes).
If the implementation of this function is changed, all
size parameters to mlog_open() should be adjusted accordingly! */
UNIV_INLINE
byte*
mlog_write_initial_log_record_fast(
......
......@@ -137,7 +137,9 @@ mlog_catenate_dulint_compressed(
}
/************************************************************
Writes the initial part of a log record. */
Writes the initial part of a log record (3..11 bytes).
If the implementation of this function is changed, all
size parameters to mlog_open() should be adjusted accordingly! */
UNIV_INLINE
byte*
mlog_write_initial_log_record_fast(
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment