Skip to content
This repository has been archived by the owner on Mar 22, 2023. It is now read-only.

DOC: Extend documentation for self_relative_ptr #1222

Open
KFilipek opened this issue Oct 14, 2021 · 0 comments
Open

DOC: Extend documentation for self_relative_ptr #1222

KFilipek opened this issue Oct 14, 2021 · 0 comments
Assignees
@KFilipek
Labels
documentation new need to be triaged Type: Feature New feature or request

Comments

@KFilipek
Copy link
Contributor

KFilipek commented Oct 14, 2021 •
edited by lukaszstolarczuk

DOC: Extend documentation for self_relative_ptr

Description

It would be good to add some info about limitations of self_relative_ptr (here and in the self_relative_ptr section if there is no info):

  1. self-relative ptr which resides on pmem can only be used to point to elements in the same pool.
  2. Adress of the element to which self-relative points must be aligned to 2 bytes

API Changes

N/A

Implementation details

Write example for that type of pointer.
@KFilipek KFilipek self-assigned this Oct 14, 2021
@lukaszstolarczuk lukaszstolarczuk added new need to be triaged Type: Feature New feature or request labels Oct 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@KFilipek KFilipek

Labels
documentation new need to be triaged Type: Feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@KFilipek @lukaszstolarczuk