Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/developer-guide/internal-libraries/MemArena.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,14 @@ to not be an issue, or there must be a provision for some sort of garbage collec

Generally |MemArena| is not as useful for classes that allocate their own internal memory
(such as :code:`std::string` or :code:`std::vector`), which includes most container classes. One
container class that can be easily used is :class:`IntrusiveDList` because the links are in the
container class that can be easily used is :code:`swoc::IntrusiveDList` because the links are in the
instance and therefore also in the arena.

Objects created in the arena must not have :code:`delete` called on them as this will corrupt
memory, usually leading to an immediate crash. The memory for the instance will be released when the
arena is destroyed. The destructor can be called if needed but in general if a destructor is needed
it is probably not a class that should be constructed in the arena. Looking at
:class:`IntrusiveDList` again for an example, if this is used to link objects in the arena, there is
:code`:`swoc::IntrusiveDList` again for an example, if this is used to link objects in the arena, there is
Copy link
Contributor

@ywkaras ywkaras Jul 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The underlying problem is the class data is populated by other document files, in this particular case by "intrusive_dlist.en.rst" which no longer exists.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The curse of Sphinx is inescapable.

no need for a destructor to clean up the links - all of the objects will be de-allocated when the
arena is destroyed. Whether this kind of situation can be arranged with reasonable effort is a good
heuristic on whether |MemArena| is an appropriate choice.
Expand Down
1 change: 0 additions & 1 deletion doc/developer-guide/internal-libraries/index.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,4 @@ development team.
MemSpan.en
TextView.en
buffer-writer.en
intrusive-list.en
scalar.en
234 changes: 0 additions & 234 deletions doc/developer-guide/internal-libraries/intrusive-list.en.rst

This file was deleted.

Loading