X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?p=pintos-anon;a=blobdiff_plain;f=doc%2Freference.texi;h=3d7d9bcbd2bbb2df58152293f4b09173cb60aff4;hp=5e4db9e8fc482065383f73f5fe4bb7f7049b4571;hb=cf90ac565e9533a17c5d4edff1e250a312396184;hpb=922af9ed1bd72fbf4a4c77ab6ddde78a7b6c3e97

diff --git a/doc/reference.texi b/doc/reference.texi
index 5e4db9e..3d7d9bc 100644
--- a/doc/reference.texi
+++ b/doc/reference.texi
@@ -844,6 +844,11 @@ char get (void) @{
 @}
 @end example
 
+Note that @code{BUF_SIZE} must divide evenly into @code{SIZE_MAX + 1}
+for the above code to be completely correct.  Otherwise, it will fail
+the first time @code{head} wraps around to 0.  In practice,
+@code{BUF_SIZE} would ordinarily be a power of 2.
+
 @node Optimization Barriers
 @subsection Optimization Barriers