Skip to content

Commit 9d4984a

Browse files
committed
common: xxx
Signed-off-by: Jan Michalski <jan-marian.michalski@hpe.com>
1 parent ed92823 commit 9d4984a

3 files changed

Lines changed: 5 additions & 44 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ of code and contributing it out of the blue.
99
There are several good ways to suggest new features, offer to add a feature,
1010
or just begin a dialog about the Persistent Memory Development Kit:
1111

12-
* Open an issue in our [GitHub Issues Database](https://github.com/pmem/pmdk/issues)
13-
* Suggest a feature, ask a question, start a discussion, etc. in our [pmem Google group](https://groups.google.com/group/pmem)
14-
* Chat with members of the PMDK team real-time on the **#pmem** IRC channel on [OFTC](https://www.oftc.net)
15-
1612
**NOTE: If you do decide to implement code changes and contribute them,
1713
please make sure you agree your contribution can be made available
1814
under the [BSD-style License used for the Persistent Memory Development Kit](LICENSE.txt).**
@@ -88,16 +84,8 @@ no clang-format or it pointing to an older version. In such case run:
8884
$ make CLANG_FORMAT=/path/to/clang-format cstyle|format
8985
```
9086

91-
If you are actively working on a PMDK feature, please let other
92-
developers know by [creating an issue](https://github.com/pmem/pmdk/issues).
93-
Use the template `Feature` and assign it to yourself (due to the way
94-
GitHub permissions work, you may have to ask a team member to assign it to you).
95-
9687
### Bug Reports
9788

98-
Bugs for the PMDK project are tracked in our
99-
[GitHub Issues Database](https://github.com/pmem/pmdk/issues).
100-
10189
When reporting a new bug, please use `New issue` button, pick proper template and fill
10290
in all fields. Provide as much information as possible, including the product version:
10391

INSTALL.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,6 @@ You will need to install the following required packages on the build system:
1717
* **libdaxctl-devel** (v63 or later)
1818
* **pandoc** (for documentation, required during install)
1919

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-
3020
## Building PMDK
3121

3222
To build from source, clone this tree:
@@ -48,21 +38,6 @@ Once all required [dependencies](#dependencies) are installed, PMDK is built usi
4838
make
4939
```
5040

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-
6641
## Installing PMDK
6742

6843
After compiling the libraries, you can install them:
@@ -107,7 +82,7 @@ Both building and installation scripts are very flexible. To see additional opti
10782

10883
### Memory Management Tools
10984

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).
11186
By default, support for all tools is enabled. If you wish to disable it, supply the compiler with `VALGRIND` flag set to 0:
11287

11388
```sh

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@
1010

1111
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.
1212

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).
1414

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.
1816

1917
## Contents
2018
1. [Libraries and Utilities](#libraries-and-utilities)
@@ -59,8 +57,8 @@ Additionally, we recommend reading [Introduction to Programming with Persistent
5957

6058
## Version Conventions
6159

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`.
6462

6563
## Building and installing
6664

0 commit comments

Comments
 (0)