[PATCH] D95210: Update the ProgrammersManual explanation for ilist and iplist

[Nathan Lanza via Phabricator via llvm-commits]

lanza created this revision.
lanza added a reviewer: dexonsmith.
lanza requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

They are now `using` aliases and thus the comments about iplist are now
incorrect. Remove them here.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D95210

Files:
  llvm/docs/ProgrammersManual.rst


Index: llvm/docs/ProgrammersManual.rst
===================================================================
--- llvm/docs/ProgrammersManual.rst
+++ llvm/docs/ProgrammersManual.rst
@@ -1665,6 +1665,9 @@
 list, and ``ilist``\ s are guaranteed to support a constant-time splice
 operation.
 
+An ``ilist`` and an ``iplist`` are ``using`` aliases to one another and the
+latter only currently exists for historical purposes.
+
 These properties are exactly what we want for things like ``Instruction``\ s and
 basic blocks, which is why these are implemented with ``ilist``\ s.
 
@@ -1672,8 +1675,6 @@
 
 * :ref:`ilist_traits <dss_ilist_traits>`
 
-* :ref:`iplist <dss_iplist>`
-
 * :ref:`llvm/ADT/ilist_node.h <dss_ilist_node>`
 
 * :ref:`Sentinels <dss_ilist_sentinel>`
@@ -1714,19 +1715,8 @@
 ilist_traits
 ^^^^^^^^^^^^
 
-``ilist_traits<T>`` is ``ilist<T>``'s customization mechanism. ``iplist<T>``
-(and consequently ``ilist<T>``) publicly derive from this traits class.
-
-.. _dss_iplist:
-
-iplist
-^^^^^^
-
-``iplist<T>`` is ``ilist<T>``'s base and as such supports a slightly narrower
-interface.  Notably, inserters from ``T&`` are absent.
-
-``ilist_traits<T>`` is a public base of this class and can be used for a wide
-variety of customizations.
+``ilist_traits<T>`` is ``ilist<T>``'s customization mechanism. ``ilist<T>``
+publicly derives from this traits class.
 
 .. _dss_ilist_node:
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D95210.318445.patch
Type: text/x-patch
Size: 1398 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210122/e8f30895/attachment.bin>