]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Clarified and corrected documentation.
authorFrancesco Chemolli <kinkie@squid-cache.org>
Sat, 21 Jan 2012 08:06:33 +0000 (09:06 +0100)
committerFrancesco Chemolli <kinkie@squid-cache.org>
Sat, 21 Jan 2012 08:06:33 +0000 (09:06 +0100)
compat/compat.dox

index a5557a0d707b127e373029351b72f352bfa1fe02..2193544ef02f79ecfd400a63e146ec8483fc709f 100644 (file)
@@ -72,7 +72,9 @@ individual part separately a risky operation.
 Squid coding guidelines require each .c and .cc file to include squid-old.h or squid.h first
 in their included files. squid.h begin with an order-specific sequence of defines and
 includes compat/compat.h to incorporate the compat layer appropriately in every soure file.
-squid.h begins by including squid.h to prepare for its sub-includes and definitions.
+squid-old.h begins by including squid.h to prepare for its sub-includes and definitions.
+It is recommended to include squid.h and not squid-old.h for new developments; squid-old.h
+is being deprecated.
 
 \par
 Internally the compat/ directory contains the public API file compat/compat.h which structures