Skip to content
Snippets Groups Projects
Unverified Commit 5a03fe6b authored by Marcin Ślusarz's avatar Marcin Ślusarz Committed by GitHub
Browse files

Merge pull request #3977 from pmem-bot/master

doc: automatic master docs update
parents 2a2ebe62 9bab164e
Branches 1.2
No related tags found
No related merge requests found
.\" Automatically generated by Pandoc 2.0.6 .\" Automatically generated by Pandoc 2.0.6
.\" .\"
.TH "LIBVMEM" "7" "2019-07-10" "PMDK - vmem API version 1.1" "PMDK Programmer's Manual" .TH "LIBVMEM" "7" "2019-09-26" "PMDK - vmem API version 1.1" "PMDK Programmer's Manual"
.hy .hy
.\" Copyright 2014-2019, Intel Corporation .\" Copyright 2014-2019, Intel Corporation
.\" .\"
...@@ -86,6 +86,12 @@ Development Kit\f[] because it is sometimes useful to use non\-volatile ...@@ -86,6 +86,12 @@ Development Kit\f[] because it is sometimes useful to use non\-volatile
memory as a volatile memory pool, leveraging its capacity, cost, or memory as a volatile memory pool, leveraging its capacity, cost, or
performance characteristics. performance characteristics.
.PP .PP
It is recommended that new code uses \f[B]memkind\f[](3) instead of
\f[B]libvmem\f[], as this library is no longer actively developed and
lacks certain features of \f[B]memkind\f[] such as NUMA awareness.
Nevertheless, it is mature, and is expected to be maintained for
foreseable future.
.PP
\f[B]libvmem\f[] uses the \f[B]mmap\f[](2) system call to create a pool \f[B]libvmem\f[] uses the \f[B]mmap\f[](2) system call to create a pool
of volatile memory. of volatile memory.
The library is most useful when used with \f[I]Direct Access\f[] storage The library is most useful when used with \f[I]Direct Access\f[] storage
......
.\" Automatically generated by Pandoc 2.0.6 .\" Automatically generated by Pandoc 2.0.6
.\" .\"
.TH "LIBVMMALLOC" "7" "2019-07-10" "PMDK - vmmalloc API version 1.1" "PMDK Programmer's Manual" .TH "LIBVMMALLOC" "7" "2019-09-26" "PMDK - vmmalloc API version 1.1" "PMDK Programmer's Manual"
.hy .hy
.\" Copyright 2014-2019, Intel Corporation .\" Copyright 2014-2019, Intel Corporation
.\" .\"
...@@ -96,6 +96,10 @@ Memory Development Kit\f[] because it is sometimes useful to use ...@@ -96,6 +96,10 @@ Memory Development Kit\f[] because it is sometimes useful to use
non\-volatile memory as a volatile memory pool, leveraging its capacity, non\-volatile memory as a volatile memory pool, leveraging its capacity,
cost, or performance characteristics. cost, or performance characteristics.
.PP .PP
This library is no longer actively developed, and is in maintenance
mode, same as its underlying code backend (\f[B]libvmem\f[]).
It is mature, and is expected to be supported for foreseable future.
.PP
\f[B]libvmmalloc\f[] may be also linked to the program, by providing the \f[B]libvmmalloc\f[] may be also linked to the program, by providing the
**\-lvmmalloc* argument to the linker. **\-lvmmalloc* argument to the linker.
Then it becomes the default memory allocator for the program. Then it becomes the default memory allocator for the program.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment