Skip to content

Commit

Permalink
Fix synopses in mysys APIs
Browse files Browse the repository at this point in the history
Since 7c58e97 the PSI_memory_key was added to some routines in the
mysys/. This commit fixes synopses of functions that were updated with
the PSI_memory_key parameter.
  • Loading branch information
0xAX authored and grooverdan committed Jan 5, 2023
1 parent 494acc1 commit d0a534d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
1 change: 1 addition & 0 deletions mysys/array.c
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
SYNOPSIS
init_dynamic_array2()
ps_key Key to register instrumented memory
array Pointer to an array
element_size Size of element
init_buffer Initial buffer pointer
Expand Down
3 changes: 2 additions & 1 deletion mysys/hash.c
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ my_hash_value_type my_hash_sort(CHARSET_INFO *cs, const uchar *key,
dynamic array that is part of the hash will allocate memory
as required during insertion.
@param[in] psi_key The key to register instrumented memory
@param[in,out] hash The hash that is initialized
@param[in[ growth_size size incrememnt for the underlying dynarray
@param[in] growth_size size incrememnt for the underlying dynarray
@param[in] charset The character set information
@param[in] size The hash size
@param[in] key_offest The key offset for the hash
Expand Down
2 changes: 1 addition & 1 deletion mysys/my_alloc.c
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
SYNOPSIS
init_alloc_root()
key - key to register instrumented memory
mem_root - memory root to initialize
name - name of memroot (for debugging)
block_size - size of chunks (blocks) used for memory allocation
(It is external size of chunk i.e. it should include
memory required for internal structures, thus it
Expand Down
4 changes: 3 additions & 1 deletion mysys/my_malloc.c
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ void set_malloc_size_cb(MALLOC_SIZE_CB func)
/**
Allocate a sized block of memory.
@param key Key to register instrumented memory
@param size The size of the memory block in bytes.
@param flags Failure action modifiers (bitmasks).
Expand Down Expand Up @@ -120,7 +121,8 @@ void *my_malloc(PSI_memory_key key, size_t size, myf my_flags)
/**
@brief wrapper around realloc()
@param old_point pointer to currently allocated area
@param key key to register instrumented memory
@param old_point pointer to currently allocated area
@param size new size requested, must be >0
@param my_flags flags
Expand Down

0 comments on commit d0a534d

Please sign in to comment.