summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorunknown <marko@hundin.mysql.fi>2004-06-18 15:54:19 +0300
committerunknown <marko@hundin.mysql.fi>2004-06-18 15:54:19 +0300
commiteac5455aa4c72f9f9a4b491c32965366e683a5cb (patch)
treef90cc8b90ad12ad15f6ce33014928e60e5171a51
parent20985f3e90a80328c3290b5a630a631337946ea7 (diff)
downloadmariadb-git-eac5455aa4c72f9f9a4b491c32965366e683a5cb.tar.gz
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()
-rw-r--r--innobase/include/mach0data.h6
-rw-r--r--innobase/include/mach0data.ic4
-rw-r--r--innobase/include/mtr0log.h4
-rw-r--r--innobase/include/mtr0log.ic4
4 files changed, 11 insertions, 7 deletions
diff --git a/innobase/include/mach0data.h b/innobase/include/mach0data.h
index f28c9422670..7ad760cd60f 100644
--- a/innobase/include/mach0data.h
+++ b/innobase/include/mach0data.h
@@ -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(
diff --git a/innobase/include/mach0data.ic b/innobase/include/mach0data.ic
index 65e5df2178e..5073404b86a 100644
--- a/innobase/include/mach0data.ic
+++ b/innobase/include/mach0data.ic
@@ -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(
diff --git a/innobase/include/mtr0log.h b/innobase/include/mtr0log.h
index 367c9a00651..785985dea16 100644
--- a/innobase/include/mtr0log.h
+++ b/innobase/include/mtr0log.h
@@ -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(
diff --git a/innobase/include/mtr0log.ic b/innobase/include/mtr0log.ic
index ad40fa525db..b0392e214f1 100644
--- a/innobase/include/mtr0log.ic
+++ b/innobase/include/mtr0log.ic
@@ -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(