From: Alex Rousskov <rousskov@measurement-factory.com>
Date: Sat, 10 Sep 2011 16:38:36 +0000 (-0600)
Subject: Renamed RockFile.h to RockDbCell.h to better match content. Polished docs.
X-Git-Tag: take08~14
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=fcd789da03c9ab0753ce8e40713b5d683543f981;p=thirdparty%2Fsquid.git

Renamed RockFile.h to RockDbCell.h to better match content. Polished docs.
---

diff --git a/src/fs/Makefile.am b/src/fs/Makefile.am
index d291e006ea..679873f25c 100644
--- a/src/fs/Makefile.am
+++ b/src/fs/Makefile.am
@@ -29,7 +29,7 @@ libufs_la_SOURCES = \
 	ufs/ufscommon.h 
 
 librock_la_SOURCES = \
-	rock/RockFile.h \
+	rock/RockDbCell.h \
 	rock/RockIoState.cc \
 	rock/RockIoState.h \
 	rock/RockIoRequests.cc \
diff --git a/src/fs/rock/RockFile.h b/src/fs/rock/RockDbCell.h
similarity index 77%
rename from src/fs/rock/RockFile.h
rename to src/fs/rock/RockDbCell.h
index 0f8dfac1eb..a644a8f080 100644
--- a/src/fs/rock/RockFile.h
+++ b/src/fs/rock/RockDbCell.h
@@ -1,13 +1,13 @@
 #ifndef SQUID_FS_ROCK_DB_CELL_H
 #define SQUID_FS_ROCK_DB_CELL_H
 
-// XXX: rename to fs/rock/RockDbCell.{cc,h}
-
 namespace Rock
 {
 
-/// \ingroup Rock
-/// meta-information at the beginning of every db cell
+/** \ingroup Rock
+ * Meta-information at the beginning of every db cell.
+ * Stored on disk and used as sizeof() argument so it must remain POD.
+ */
 class DbCellHeader
 {
 public:
diff --git a/src/fs/rock/RockRebuild.cc b/src/fs/rock/RockRebuild.cc
index c0f43ba75f..4977a9da6a 100644
--- a/src/fs/rock/RockRebuild.cc
+++ b/src/fs/rock/RockRebuild.cc
@@ -7,7 +7,7 @@
 #include "config.h"
 #include "fs/rock/RockRebuild.h"
 #include "fs/rock/RockSwapDir.h"
-#include "fs/rock/RockFile.h"
+#include "fs/rock/RockDbCell.h"
 #include "SquidTime.h"
 
 CBDATA_NAMESPACED_CLASS_INIT(Rock, Rebuild);
diff --git a/src/fs/rock/RockSwapDir.h b/src/fs/rock/RockSwapDir.h
index 00659d5b0c..4efb619ef4 100644
--- a/src/fs/rock/RockSwapDir.h
+++ b/src/fs/rock/RockSwapDir.h
@@ -4,7 +4,7 @@
 #include "SwapDir.h"
 #include "DiskIO/DiskFile.h"
 #include "DiskIO/IORequestor.h"
-#include "fs/rock/RockFile.h"
+#include "fs/rock/RockDbCell.h"
 #include "ipc/StoreMap.h"
 
 class DiskIOStrategy;