[PATCH] Document bi_sector and sector_t

[deliverable/linux.git] / include / linux / types.h

diff --git a/include/linux/types.h b/include/linux/types.h
index 406d4ae57631709542ad5097b1aba9216fa2a4c3..750f085fa564f75a0547a7ddcc38176cb63d4571 100644 (file)
--- a/include/linux/types.h
+++ b/include/linux/types.h
@@ -129,8 +129,12 @@ typedef            __s64           int64_t;
 /* this is a special 64bit data type that is 8-byte aligned */
 #define aligned_u64 unsigned long long __attribute__((aligned(8)))
 
-/*
+/**
  * The type used for indexing onto a disc or disc partition.
+ *
+ * Linux always considers sectors to be 512 bytes long independently
+ * of the devices real block size.
+ *
  * If required, asm/types.h can override it and define
  * HAVE_SECTOR_T
  */