Pmdk summary

[grom72]

Requires:

• Use release 2.0.0 instead of 1.14.0 #368

Preview:
https://grom72.github.io/pmdk/

This change is 

[janekmi]

Reviewed 33 of 33 files at r1, all commit messages.
Reviewable status: all files reviewed, 12 unresolved discussions (waiting on @grom72)

---

data/en/pmdk.yml line 15 at r1 (raw file):

  title: ''
  content_banner:
    bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository on the GitHub</a> has been the ultimate source of information since the release 2.0.0!</p>'

Suggestion:

'<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository</a> on GitHub is the ultimate source of information from release 2.0!</p>'

---

data/en/pmdk.yml line 16 at r1 (raw file):

  content_banner:
    bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository on the GitHub</a> has been the ultimate source of information since the release 2.0.0!</p>'
    text: 'This website is valid up to PMDK release 1.13.0. It is not guaranteed that the content of this site reflects the latest state of PMDK-related knowledge.'

Suggestion:

'The PMDK documentation collected here should be valid up to the 1.13.1 release but is maintained only on a best-effort basis and may not reflect the latest state of the art.'

---

data/en/pmdk.yml line 21 at r1 (raw file):

libraries_section:
  enable: true
  title: "<p>The following libraries are part of the PMDK starting release 2.0.0.</p>"

Suggestion:

The following libraries are active parts of the PMDK.

---

data/en/pmdk.yml line 29 at r1 (raw file):

    library_item2:
      title: 'libpmem'
      content: "<p>The <strong>libpmem</strong> library provides low level persistent memory support. The libraries above are implemented using <strong>libpmem</strong>. Developers wishing to roll their own persistent memory algorithms will find this library useful, but most developers will likely use <strong>libpmemobj</strong> above and let that library call <strong>libpmem</strong> for them.</p>

Suggestion:

The <strong>libpmem</strong> library provides low-level persistent memory support.

---

data/en/pmdk.yml line 33 at r1 (raw file):

    library_item3:
      title: 'libpmem2'
      content: "<p>The <strong>libpmem2</strong> library provides low level persistent memory support. The library is a new version of <strong>libpmem</strong>. <strong>libpmem2</strong> provides a more universal and platform-agnostic interface. Developers wishing to roll their own persistent memory algorithms will find this library useful, but most developers will likely use <strong>libpmemobj</strong> above that provides memory allocation and transactions support.</p>

Suggestion:

<p>The <strong>libpmem2</strong> library provides low-level persistent memory support.

---

data/en/pmdk.yml line 35 at r1 (raw file):

      content: "<p>The <strong>libpmem2</strong> library provides low level persistent memory support. The library is a new version of <strong>libpmem</strong>. <strong>libpmem2</strong> provides a more universal and platform-agnostic interface. Developers wishing to roll their own persistent memory algorithms will find this library useful, but most developers will likely use <strong>libpmemobj</strong> above that provides memory allocation and transactions support.</p>
                <p>See the <a href=\"./libpmem2\">libpmem2 page</a> for documentation and examples.</p>
                <blockquote><p><strong>Note:</strong>Support for experimental <strong>async</strong> functions is available only in the release 1.13.0 and before.</p></blockquote>"

Suggestion:

<strong>Note: </strong>Support

---

data/en/pmdk.yml line 56 at r1 (raw file):

Discontinuation:
  enable: true
  title: 'Discontinuation of the project'

Suggestion:

Discontinued projects

---

data/en/pmdk.yml line 59 at r1 (raw file):

  lists:
    branch_list1: 
      content: "<p>The <strong>libpmemblk</strong>, <strong>libpmemlog</strong>, <strong>librpma</strong>, <strong>libpmemset</strong>, <strong>libvmem</strong>, <strong>librpmem</strong>, <strong>libvmemcache</strong>, <strong>pmdk-convert</strong>, <strong>libpmemobj-cpp</strong> and <strong>pmemkv</strong> libraries will no longer be maintained by Intel.</p>"

Suggestion:

content: "<p>The following libraries are no longer maintained. If you need to use any of these projects, are interested in independently developing it, or would like to maintain patches for the open-source software community, please create your own fork for the project of interest. You will find more information <a href=\"/blog/2022/11/update-on-pmdk-and-our-long-term-support-strategy/\">here</a>.</p>"

---

data/en/pmdk.yml line 70 at r1 (raw file):

                    maintain patches for the open source software community, please create your own fork of this project."
        list_item4:
          content: "You will find more information <a href=\"/blog/2022/11/update-on-pmdk-and-our-long-term-support-strategy/\">here</a>."

---

data/en/pmdk.yml line 73 at r1 (raw file):

    branch_list2:
      content: "<p>Support for <strong>Windows</strong> and <strong>FreeBSD</strong> are deprecated since <strong>PMDK 1.13.0</strong> release and will be removed in the <strong>PMDK 2.0.0</strong> release.</p>"

Suggestion:

Support for <strong>Windows</strong> and <strong>FreeBSD</strong> has been deprecated since the <strong>PMDK 1.13.0</strong> release and was removed in the <strong>PMDK 2.0.0 release</strong>.

---

data/en/pmdk.yml line 79 at r1 (raw file):

  enable: true
  title: 'Documentation of discontinuated componennts'
  content: "<p>The <strong>libpmemblk</strong> library supports arrays of pmem-resident blocks, all the same size, that are atomically updated. For example, a program keeping a cache of fixed-size objects in pmem might find this library useful.</p>"

I believe this part is not used at all, is it?

---

themes/pmem-hugo/layouts/pmdk/list.html line 25 at r1 (raw file):

<!-- 
      <span class="fw-bold"><a href="{{ .download_link.link | absLangURL }}">{{ .download_link.label }}</a></span>
-->

[grom72]

Reviewable status: 0 of 33 files reviewed, 12 unresolved discussions (waiting on @janekmi)

---

data/en/pmdk.yml line 15 at r1 (raw file):

  title: ''
  content_banner:
    bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository on the GitHub</a> has been the ultimate source of information since the release 2.0.0!</p>'

Done.

---

data/en/pmdk.yml line 16 at r1 (raw file):

  content_banner:
    bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository on the GitHub</a> has been the ultimate source of information since the release 2.0.0!</p>'
    text: 'This website is valid up to PMDK release 1.13.0. It is not guaranteed that the content of this site reflects the latest state of PMDK-related knowledge.'

Done.

---

data/en/pmdk.yml line 21 at r1 (raw file):

libraries_section:
  enable: true
  title: "<p>The following libraries are part of the PMDK starting release 2.0.0.</p>"

Done.

---

data/en/pmdk.yml line 29 at r1 (raw file):

    library_item2:
      title: 'libpmem'
      content: "<p>The <strong>libpmem</strong> library provides low level persistent memory support. The libraries above are implemented using <strong>libpmem</strong>. Developers wishing to roll their own persistent memory algorithms will find this library useful, but most developers will likely use <strong>libpmemobj</strong> above and let that library call <strong>libpmem</strong> for them.</p>

Done.

---

data/en/pmdk.yml line 33 at r1 (raw file):

    library_item3:
      title: 'libpmem2'
      content: "<p>The <strong>libpmem2</strong> library provides low level persistent memory support. The library is a new version of <strong>libpmem</strong>. <strong>libpmem2</strong> provides a more universal and platform-agnostic interface. Developers wishing to roll their own persistent memory algorithms will find this library useful, but most developers will likely use <strong>libpmemobj</strong> above that provides memory allocation and transactions support.</p>

Done.

---

data/en/pmdk.yml line 35 at r1 (raw file):

      content: "<p>The <strong>libpmem2</strong> library provides low level persistent memory support. The library is a new version of <strong>libpmem</strong>. <strong>libpmem2</strong> provides a more universal and platform-agnostic interface. Developers wishing to roll their own persistent memory algorithms will find this library useful, but most developers will likely use <strong>libpmemobj</strong> above that provides memory allocation and transactions support.</p>
                <p>See the <a href=\"./libpmem2\">libpmem2 page</a> for documentation and examples.</p>
                <blockquote><p><strong>Note:</strong>Support for experimental <strong>async</strong> functions is available only in the release 1.13.0 and before.</p></blockquote>"

Done.

---

data/en/pmdk.yml line 56 at r1 (raw file):

Discontinuation:
  enable: true
  title: 'Discontinuation of the project'

Done.

---

data/en/pmdk.yml line 59 at r1 (raw file):

  lists:
    branch_list1: 
      content: "<p>The <strong>libpmemblk</strong>, <strong>libpmemlog</strong>, <strong>librpma</strong>, <strong>libpmemset</strong>, <strong>libvmem</strong>, <strong>librpmem</strong>, <strong>libvmemcache</strong>, <strong>pmdk-convert</strong>, <strong>libpmemobj-cpp</strong> and <strong>pmemkv</strong> libraries will no longer be maintained by Intel.</p>"

Done.

---

data/en/pmdk.yml line 70 at r1 (raw file):

                    maintain patches for the open source software community, please create your own fork of this project."
        list_item4:
          content: "You will find more information <a href=\"/blog/2022/11/update-on-pmdk-and-our-long-term-support-strategy/\">here</a>."

Done.

---

data/en/pmdk.yml line 73 at r1 (raw file):

    branch_list2:
      content: "<p>Support for <strong>Windows</strong> and <strong>FreeBSD</strong> are deprecated since <strong>PMDK 1.13.0</strong> release and will be removed in the <strong>PMDK 2.0.0</strong> release.</p>"

Done.

---

data/en/pmdk.yml line 79 at r1 (raw file):

Previously, janekmi (Jan Michalski) wrote…

I believe this part is not used at all, is it?

Done.

---

themes/pmem-hugo/layouts/pmdk/list.html line 25 at r1 (raw file):

<!-- 
      <span class="fw-bold"><a href="{{ .download_link.link | absLangURL }}">{{ .download_link.label }}</a></span>
-->

Done.

[janekmi]

Reviewed 31 of 32 files at r2, 2 of 2 files at r3, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @grom72)

---

data/en/pmdk.yml line 15 at r3 (raw file):

  title: ''
  content_banner:
    bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository</a> on the GitHub is the ultimate source from release 2.0!</p>'

Suggestion:

GitHub

[grom72]

Reviewed 1 of 2 files at r4.
Reviewable status: 32 of 33 files reviewed, 1 unresolved discussion (waiting on @janekmi)

---

data/en/pmdk.yml line 15 at r3 (raw file):

  title: ''
  content_banner:
    bold_text: '<p>The <a href=\"https://github.com/pmem/pmdk/\">PMDK repository</a> on the GitHub is the ultimate source from release 2.0!</p>'

Done.

[janekmi]

Reviewed 1 of 2 files at r4, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @grom72)