From 74d4d1558655db85bfccfe9604400c2e5ebd2b7f Mon Sep 17 00:00:00 2001
From: Scott Schurr <scott@ripple.com>
Date: Mon, 8 Jul 2024 13:29:48 -0700
Subject: [PATCH] [chore] Rename two files from Directory* to Dir*:

The names of the files should reflect the name of the Dir class.
---
 src/test/app/Escrow_test.cpp                       |  2 +-
 src/test/app/PayChan_test.cpp                      |  2 +-
 src/test/ledger/Directory_test.cpp                 |  1 -
 src/xrpld/app/paths/detail/BookStep.cpp            |  1 -
 src/xrpld/app/tx/detail/NFTokenBurn.cpp            |  1 -
 src/xrpld/app/tx/detail/NFTokenUtils.cpp           |  2 +-
 src/xrpld/ledger/{Directory.h => Dir.h}            | 12 ++++++++++++
 src/xrpld/ledger/detail/{Directory.cpp => Dir.cpp} |  2 +-
 8 files changed, 16 insertions(+), 7 deletions(-)
 rename src/xrpld/ledger/{Directory.h => Dir.h} (86%)
 rename src/xrpld/ledger/detail/{Directory.cpp => Dir.cpp} (98%)

diff --git a/src/test/app/Escrow_test.cpp b/src/test/app/Escrow_test.cpp
index 813f26da736..0f465a14f4d 100644
--- a/src/test/app/Escrow_test.cpp
+++ b/src/test/app/Escrow_test.cpp
@@ -19,7 +19,7 @@
 
 #include <test/jtx.h>
 #include <xrpld/app/tx/applySteps.h>
-#include <xrpld/ledger/Directory.h>
+#include <xrpld/ledger/Dir.h>
 #include <xrpl/protocol/Feature.h>
 #include <xrpl/protocol/Indexes.h>
 #include <xrpl/protocol/TxFlags.h>
diff --git a/src/test/app/PayChan_test.cpp b/src/test/app/PayChan_test.cpp
index a8eae4a25ec..0dffe5e388f 100644
--- a/src/test/app/PayChan_test.cpp
+++ b/src/test/app/PayChan_test.cpp
@@ -18,7 +18,7 @@
 //==============================================================================
 
 #include <test/jtx.h>
-#include <xrpld/ledger/Directory.h>
+#include <xrpld/ledger/Dir.h>
 #include <xrpld/rpc/detail/RPCHelpers.h>
 #include <xrpl/basics/chrono.h>
 #include <xrpl/protocol/Feature.h>
diff --git a/src/test/ledger/Directory_test.cpp b/src/test/ledger/Directory_test.cpp
index 1a14feff061..4904b6e6fbf 100644
--- a/src/test/ledger/Directory_test.cpp
+++ b/src/test/ledger/Directory_test.cpp
@@ -17,7 +17,6 @@
 
 #include <test/jtx.h>
 #include <xrpld/ledger/BookDirs.h>
-#include <xrpld/ledger/Directory.h>
 #include <xrpld/ledger/Sandbox.h>
 #include <xrpl/basics/random.h>
 #include <xrpl/protocol/Feature.h>
diff --git a/src/xrpld/app/paths/detail/BookStep.cpp b/src/xrpld/app/paths/detail/BookStep.cpp
index 4fa6f140aae..96971a516fc 100644
--- a/src/xrpld/app/paths/detail/BookStep.cpp
+++ b/src/xrpld/app/paths/detail/BookStep.cpp
@@ -23,7 +23,6 @@
 #include <xrpld/app/paths/detail/FlatSets.h>
 #include <xrpld/app/paths/detail/Steps.h>
 #include <xrpld/app/tx/detail/OfferStream.h>
-#include <xrpld/ledger/Directory.h>
 #include <xrpld/ledger/PaymentSandbox.h>
 #include <xrpl/basics/IOUAmount.h>
 #include <xrpl/basics/Log.h>
diff --git a/src/xrpld/app/tx/detail/NFTokenBurn.cpp b/src/xrpld/app/tx/detail/NFTokenBurn.cpp
index f43dda71f59..725e35791f9 100644
--- a/src/xrpld/app/tx/detail/NFTokenBurn.cpp
+++ b/src/xrpld/app/tx/detail/NFTokenBurn.cpp
@@ -19,7 +19,6 @@
 
 #include <xrpld/app/tx/detail/NFTokenBurn.h>
 #include <xrpld/app/tx/detail/NFTokenUtils.h>
-#include <xrpld/ledger/Directory.h>
 #include <xrpld/ledger/View.h>
 #include <xrpl/protocol/Feature.h>
 #include <xrpl/protocol/Protocol.h>
diff --git a/src/xrpld/app/tx/detail/NFTokenUtils.cpp b/src/xrpld/app/tx/detail/NFTokenUtils.cpp
index 342b3805a0e..279bf6b9816 100644
--- a/src/xrpld/app/tx/detail/NFTokenUtils.cpp
+++ b/src/xrpld/app/tx/detail/NFTokenUtils.cpp
@@ -18,7 +18,7 @@
 //==============================================================================
 
 #include <xrpld/app/tx/detail/NFTokenUtils.h>
-#include <xrpld/ledger/Directory.h>
+#include <xrpld/ledger/Dir.h>
 #include <xrpld/ledger/View.h>
 #include <xrpl/basics/algorithm.h>
 #include <xrpl/protocol/Feature.h>
diff --git a/src/xrpld/ledger/Directory.h b/src/xrpld/ledger/Dir.h
similarity index 86%
rename from src/xrpld/ledger/Directory.h
rename to src/xrpld/ledger/Dir.h
index cc8b3c13a3a..0e92d7dbca6 100644
--- a/src/xrpld/ledger/Directory.h
+++ b/src/xrpld/ledger/Dir.h
@@ -25,6 +25,18 @@
 
 namespace ripple {
 
+/** A class that simplifies iterating ledger directory pages
+
+    The Dir class provides a forward iterator for walking through
+    the uint256 values contained in ledger directories.
+
+    The Dir class also allows accelerated directory walking by
+    stepping directly from one page to the next using the next_page()
+    member function.
+
+    As of July 2024, the Dir class is only being used with NFTokenOffer
+    directories and for unit tests.
+*/
 class Dir
 {
 private:
diff --git a/src/xrpld/ledger/detail/Directory.cpp b/src/xrpld/ledger/detail/Dir.cpp
similarity index 98%
rename from src/xrpld/ledger/detail/Directory.cpp
rename to src/xrpld/ledger/detail/Dir.cpp
index 9153d013fd8..6004a73095c 100644
--- a/src/xrpld/ledger/detail/Directory.cpp
+++ b/src/xrpld/ledger/detail/Dir.cpp
@@ -17,7 +17,7 @@
 */
 //==============================================================================
 
-#include <xrpld/ledger/Directory.h>
+#include <xrpld/ledger/Dir.h>
 
 namespace ripple {