You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+1-26Lines changed: 1 addition & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,16 +17,6 @@ You will need to install the following required packages on the build system:
17
17
***libdaxctl-devel** (v63 or later)
18
18
***pandoc** (for documentation, required during install)
19
19
20
-
The following packages are required only by selected PMDK components
21
-
or features:
22
-
23
-
PMDK depends on libndctl and libdaxctl to support RAS features. It is possible
24
-
to disable this support by passing `NDCTL_ENABLE=n` to `make`, but we strongly
25
-
discourage users from doing that. Disabling NDCTL strips PMDK from ability to
26
-
detect hardware failures, which may lead to silent data corruption.
27
-
For information how to disable RAS at runtime for kernels prior to 5.0.4 please
28
-
see https://github.com/pmem/pmdk/issues/4207.
29
-
30
20
## Building PMDK
31
21
32
22
To build from source, clone this tree:
@@ -48,21 +38,6 @@ Once all required [dependencies](#dependencies) are installed, PMDK is built usi
48
38
make
49
39
```
50
40
51
-
By default, all code is built with the `-Werror` flag, which fails
52
-
the whole build when the compiler emits any warning. This is very useful during
53
-
development, but can be annoying in deployment. If you want to disable `-Werror`,
54
-
use the `EXTRA_CFLAGS` variable:
55
-
56
-
```sh
57
-
make EXTRA_CFLAGS="-Wno-error"
58
-
```
59
-
60
-
>or
61
-
62
-
```sh
63
-
make EXTRA_CFLAGS="-Wno-error=$(type-of-warning)"
64
-
```
65
-
66
41
## Installing PMDK
67
42
68
43
After compiling the libraries, you can install them:
@@ -107,7 +82,7 @@ Both building and installation scripts are very flexible. To see additional opti
107
82
108
83
### Memory Management Tools
109
84
110
-
The PMDK libraries support standard Valgrind DRD, Helgrind and Memcheck, as well as a PM-aware version of [Valgrind](https://github.com/pmem/valgrind).
85
+
The PMDK libraries support standard Valgrind DRD, Helgrind and Memcheck, as well as a PMEM-aware version of [Valgrind](https://github.com/pmem/valgrind).
111
86
By default, support for all tools is enabled. If you wish to disable it, supply the compiler with `VALGRIND` flag set to 0:
Copy file name to clipboardExpand all lines: README.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,9 @@
10
10
11
11
The **Persistent Memory Development Kit (PMDK)** is a collection of libraries and tools for System Administrators and Application Developers to simplify managing and accessing persistent memory devices. For more information, see https://pmem.io.
12
12
13
-
To install PMDK libraries please clone the tree and build it yourself. Specific installation instructions are outlined below.
13
+
The only supported user is the [DAOS Project](https://daos.io/). Bugs and feature requests for PMDK are tracked [here](https://daosio.atlassian.net/issues?jql=component%20%3D%20PMDK%20ORDER%20BY%20created%20DESC). Older known issues can be found [here](https://github.com/pmem/pmdk/issues).
14
14
15
-
Pre-built packages can be found in popular Linux distribution package repositories but we do not keep them anymore up to date because of the limited resources.
16
-
17
-
Bugs and feature requests for this repo are tracked in our [GitHub Issues Database](https://github.com/pmem/pmdk/issues).
15
+
PMDK is delivered as part of a DAOS release. If you want to experiment with PMDK without DAOS it is recommended to build it yourself as outlined [below](#building-and-installing). Pre-built packages found in popular Linux distribution package repositories are no longer kept up to date.
18
16
19
17
## Contents
20
18
1.[Libraries and Utilities](#libraries-and-utilities)
@@ -59,8 +57,8 @@ Additionally, we recommend reading [Introduction to Programming with Persistent
59
57
60
58
## Version Conventions
61
59
62
-
-**Release Candidates** have a '-rc{version}' tag, e.g. `0.2-rc3`, meaning _Release Candidate 3 for version 0.2_
63
-
-**Stable Releases** use a _major.minor_ tag like `0.2`
60
+
-**Release Candidates** have a '-rc{version}' tag, e.g. `0.2.0-rc3`, meaning _Release Candidate 3 for version 0.2.0_
61
+
-**Stable Releases** use a _major.minor.patch_ tag like `0.2.0`.
0 commit comments