Merge pull request #6056 from osalyk/improve_doc

doc: add an exception and a macro
pmem · Mar 19, 2024 · 8004f8b · 8004f8b
2 parents eb8c8ab + 3d531e6
commit 8004f8b
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/doc/Makefile b/doc/Makefile
@@ -65,7 +65,8 @@ MANPAGES_3_DUMMY = libpmem/pmem_drain.3 libpmem/pmem_has_hw_drain.3 libpmem/pmem
  libpmemobj/pmemobj_check_version.3 libpmemobj/pmemobj_check.3 libpmemobj/pmemobj_errormsg.3 libpmemobj/pmemobj_set_funcs.3 \
  libpmemobj/pmemobj_reserve.3 libpmemobj/pmemobj_xreserve.3 libpmemobj/pmemobj_defer_free.3 libpmemobj/pmemobj_set_value.3 libpmemobj/pmemobj_publish.3 libpmemobj/pmemobj_tx_publish.3 libpmemobj/pmemobj_tx_xpublish.3 libpmemobj/pmemobj_cancel.3 libpmemobj/pobj_reserve_new.3 libpmemobj/pobj_reserve_alloc.3 libpmemobj/pobj_xreserve_new.3 libpmemobj/pobj_xreserve_alloc.3 \
  libpmemobj/tx_xstrdup.3 libpmemobj/tx_xwcsdup.3 libpmemobj/tx_xfree.3 \
- libpmemobj/pmemobj_defrag.3 libpmemobj/pmemobj_get_user_data.3 libpmemobj/pmemobj_set_user_data.3 libpmemobj/pmemobj_tx_get_user_data.3 libpmemobj/pmemobj_tx_set_user_data.3 libpmemobj/pmemobj_tx_get_failure_behavior.3 libpmemobj/pmemobj_tx_set_failure_behavior.3
+ libpmemobj/pmemobj_defrag.3 libpmemobj/pmemobj_get_user_data.3 libpmemobj/pmemobj_set_user_data.3 libpmemobj/pmemobj_tx_get_user_data.3 libpmemobj/pmemobj_tx_set_user_data.3 libpmemobj/pmemobj_tx_get_failure_behavior.3 libpmemobj/pmemobj_tx_set_failure_behavior.3 \
+ libpmemobj/pmemobj_log_use_default_function.3
 
 MANPAGES_WEBDIR_LINUX = web_linux
 

diff --git a/doc/libpmemobj/pmemobj_log_use_default_function.3 b/doc/libpmemobj/pmemobj_log_use_default_function.3
@@ -0,0 +1 @@
+.so pmemobj_log_set_function.3
diff --git a/utils/check_docs/exceptions.txt b/utils/check_docs/exceptions.txt
@@ -27,6 +27,7 @@ libpmemobj_atomic_base_h
 pobj_xalloc_valid_flags
 libpmemobj_atomic_h
 libpmemobj_iterator_base_h
+libpmemobj_log_h
 libpmemobj_pool_base_h
 pmemobj_min_pool
 pmemobj_min_part