From 020110e148bf36f30a90159be2005fd24b4d819c Mon Sep 17 00:00:00 2001 From: Adam Borowski <kilobyte@angband.pl> Date: Wed, 9 Oct 2019 22:38:58 +0200 Subject: [PATCH] common: fix manpage section references in comments and text files Fixes pmem/issues#1130. --- ChangeLog | 2 +- doc/libpmemblk/libpmemblk.7.md | 2 +- doc/libpmemlog/pmemlog_append.3.md | 2 +- doc/poolset/poolset.5.md | 6 +++--- src/examples/libpmemobj/setjmp.c | 4 ++-- src/include/README | 14 +++++++------- src/include/libpmem.h | 2 +- src/include/libpmemblk.h | 2 +- src/include/libpmemlog.h | 2 +- src/include/libpmemobj.h | 4 ++-- src/include/libpmempool.h | 2 +- src/include/librpmem.h | 2 +- src/include/libvmem.h | 2 +- src/include/libvmmalloc.h | 2 +- src/tools/pmempool/README | 2 +- 15 files changed, 25 insertions(+), 25 deletions(-) diff --git a/ChangeLog b/ChangeLog index 42b1151d1..4cae810b5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -345,7 +345,7 @@ Tue Feb 21 2017 Krzysztof Czurylo <krzysztof.czurylo@intel.com> The pmem_is_pmem() function will now return true only if the entire range is mapped directly from Device DAX (/dev/daxX.Y) without an intervening file system, and only if the corresponding file mapping - was created with pmem_map_file(). See libpmem(3) for details. + was created with pmem_map_file(). See libpmem(7) for details. Bug fixes: - jemalloc: fix test compilation on Fedora 26 (rawhide) diff --git a/doc/libpmemblk/libpmemblk.7.md b/doc/libpmemblk/libpmemblk.7.md index 99aa62753..19beb2ee3 100644 --- a/doc/libpmemblk/libpmemblk.7.md +++ b/doc/libpmemblk/libpmemblk.7.md @@ -112,7 +112,7 @@ type of file system results in the load/store, non-paged access to pmem. This library is for applications that need a potentially large array of blocks, all the same size, where any given block is updated atomically (the update cannot be *torn* by program interruption such as power failures). This library -builds on the low-level pmem support provided by **libpmem**(3), handling the +builds on the low-level pmem support provided by **libpmem**(7), handling the transactional update of the blocks, flushing to persistence, and recovery for the application. **libpmemblk** is one of a collection of persistent memory libraries available, the others are: diff --git a/doc/libpmemlog/pmemlog_append.3.md b/doc/libpmemlog/pmemlog_append.3.md index 36a71fce8..789ad2330 100644 --- a/doc/libpmemlog/pmemlog_append.3.md +++ b/doc/libpmemlog/pmemlog_append.3.md @@ -90,7 +90,7 @@ On error, they return -1 and set *errno* appropriately. # NOTES # -Since **libpmemlog**(3) is designed as a low-latency code path, +Since **libpmemlog**(7) is designed as a low-latency code path, many of the checks routinely done by the operating system for **writev**(2) are not practical in the library's implementation of **pmemlog_appendv**(). No attempt is made to detect NULL or incorrect pointers, for example. diff --git a/doc/poolset/poolset.5.md b/doc/poolset/poolset.5.md index 19e166ad7..e8ca47963 100644 --- a/doc/poolset/poolset.5.md +++ b/doc/poolset/poolset.5.md @@ -189,7 +189,7 @@ REPLICA [<user>@]<hostname> [<relative-path>/]<remote-pool-set-file> client + *pathname* is relative to the root config directory on the target -node - see **librpmem**(3) +node - see **librpmem**(7) There are no other lines in the remote replica section - the REPLICA line defines a remote replica entirely. @@ -296,11 +296,11 @@ be done with the **pmemobj_create**(3), **pmemblk_create**(3) or Restoring data from a local _WINUX(,or remote) replica can be done by using the **pmempool-sync**(1) command or the _UW(pmempool_sync) API from the -**libpmempool**(3) library. +**libpmempool**(7) library. Modifications of a pool set file configuration can be done by using the **pmempool-transform**(1) command or the _UW(pmempool_transform) API from the -**libpmempool**(3) library. +**libpmempool**(7) library. When creating a pool set consisting of multiple files, or when creating a replicated pool set, the *path* argument passed to **pmemobj_create**(3), diff --git a/src/examples/libpmemobj/setjmp.c b/src/examples/libpmemobj/setjmp.c index fa2f79750..9aed06ccc 100644 --- a/src/examples/libpmemobj/setjmp.c +++ b/src/examples/libpmemobj/setjmp.c @@ -1,5 +1,5 @@ /* - * Copyright 2016, Intel Corporation + * Copyright 2016-2019, Intel Corporation * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -33,7 +33,7 @@ /* * setjmp.c -- example illustrating an issue with indeterminate value * of non-volatile automatic variables after transaction abort. - * See libpmemobj(3) for details. + * See libpmemobj(7) for details. * * NOTE: To observe the problem (likely segfault on a second call to free()), * the example program should be compiled with optimizations enabled (-O2). diff --git a/src/include/README b/src/include/README index 6a15fc59c..0821705b0 100644 --- a/src/include/README +++ b/src/include/README @@ -12,18 +12,18 @@ the source for their module. Here you'll find: -libpmem.h -- definitions of libpmem entry points (see libpmem(3)) +libpmem.h -- definitions of libpmem entry points (see libpmem(7)) -libpmemblk.h -- definitions of libpmemblk entry points (see libpmemblk(3)) +libpmemblk.h -- definitions of libpmemblk entry points (see libpmemblk(7)) -libpmemlog.h -- definitions of libpmemlog entry points (see libpmemlog(3)) +libpmemlog.h -- definitions of libpmemlog entry points (see libpmemlog(7)) -libpmemobj.h -- definitions of libpmemobj entry points (see libpmemobj(3)) +libpmemobj.h -- definitions of libpmemobj entry points (see libpmemobj(7)) -libvmem.h -- definitions of libvmem entry points (see libvmem(3)) +libvmem.h -- definitions of libvmem entry points (see libvmem(7)) -libvmmalloc.h -- definitions of libvmmalloc entry points (see libvmmalloc(3)) +libvmmalloc.h -- definitions of libvmmalloc entry points (see libvmmalloc(7)) Experimental libraries: -librpmem.h -- definitions of librpmem entry points (see librpmem(3)) +librpmem.h -- definitions of librpmem entry points (see librpmem(7)) diff --git a/src/include/libpmem.h b/src/include/libpmem.h index 609027435..40c51d5e3 100644 --- a/src/include/libpmem.h +++ b/src/include/libpmem.h @@ -37,7 +37,7 @@ * * libpmem provides support for using raw pmem directly. * - * See libpmem(3) for details. + * See libpmem(7) for details. */ #ifndef LIBPMEM_H diff --git a/src/include/libpmemblk.h b/src/include/libpmemblk.h index 232f821cc..9fbc65dda 100644 --- a/src/include/libpmemblk.h +++ b/src/include/libpmemblk.h @@ -37,7 +37,7 @@ * * libpmemblk provides support for arrays of atomically-writable blocks. * - * See libpmemblk(3) for details. + * See libpmemblk(7) for details. */ #ifndef LIBPMEMBLK_H diff --git a/src/include/libpmemlog.h b/src/include/libpmemlog.h index f608582a5..ef08d7f36 100644 --- a/src/include/libpmemlog.h +++ b/src/include/libpmemlog.h @@ -37,7 +37,7 @@ * * libpmemlog provides support for pmem-resident log files. * - * See libpmemlog(3) for details. + * See libpmemlog(7) for details. */ #ifndef LIBPMEMLOG_H diff --git a/src/include/libpmemobj.h b/src/include/libpmemobj.h index ea7fde270..019633cb9 100644 --- a/src/include/libpmemobj.h +++ b/src/include/libpmemobj.h @@ -1,5 +1,5 @@ /* - * Copyright 2014-2018, Intel Corporation + * Copyright 2014-2019, Intel Corporation * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -37,7 +37,7 @@ * * libpmemobj provides a pmem-resident transactional object store. * - * See libpmemobj(3) for details. + * See libpmemobj(7) for details. */ #ifndef LIBPMEMOBJ_H diff --git a/src/include/libpmempool.h b/src/include/libpmempool.h index 144601fee..c08a95609 100644 --- a/src/include/libpmempool.h +++ b/src/include/libpmempool.h @@ -33,7 +33,7 @@ /* * libpmempool.h -- definitions of libpmempool entry points * - * See libpmempool(3) for details. + * See libpmempool(7) for details. */ #ifndef LIBPMEMPOOL_H diff --git a/src/include/librpmem.h b/src/include/librpmem.h index b9fb26143..ea3fc4902 100644 --- a/src/include/librpmem.h +++ b/src/include/librpmem.h @@ -36,7 +36,7 @@ * This library provides low-level support for remote access to persistent * memory utilizing RDMA-capable RNICs. * - * See librpmem(3) for details. + * See librpmem(7) for details. */ #ifndef LIBRPMEM_H diff --git a/src/include/libvmem.h b/src/include/libvmem.h index d9d841397..24bf1ce84 100644 --- a/src/include/libvmem.h +++ b/src/include/libvmem.h @@ -35,7 +35,7 @@ * * This library exposes memory-mapped files as volatile memory (a la malloc) * - * See libvmem(3) for details. + * See libvmem(7) for details. */ #ifndef LIBVMEM_H diff --git a/src/include/libvmmalloc.h b/src/include/libvmmalloc.h index 4afcb6a18..a77b48700 100644 --- a/src/include/libvmmalloc.h +++ b/src/include/libvmmalloc.h @@ -35,7 +35,7 @@ * * This library exposes memory-mapped files as volatile memory (a la malloc) * - * See libvmmalloc(3) for details. + * See libvmmalloc(7) for details. */ #ifndef LIBVMMALLOC_H diff --git a/src/tools/pmempool/README b/src/tools/pmempool/README index 6799c0008..8347ff18b 100644 --- a/src/tools/pmempool/README +++ b/src/tools/pmempool/README @@ -145,7 +145,7 @@ All features are described below. * It is possible to walk through the usable data using fixed data chunk size. This feature uses similar approach as pmemlog_walk() function. For details - please refer to libpmemlog(3). + please refer to libpmemlog(7). ** Features for *blk* pool type -- GitLab