Update ALLOCATOR() macro documentation
@@ -1615,18 +1615,24 @@ when (($PERLXS == "yes") || ($PERLXSCPP == "yes") || ($USE_PERL == "yes")) {
macro USE_PERL_LIB() {
PEERDIR(contrib/libs/platform/perl)
}
-### Available: GOOGLE, J, LF, LOCKLESS, B, SYSTEM, FAKE. Default - J (JEMalloc)
-### Style allows you to specify only programs. Use inside LIBRARY ALLOCATOR() END() leads to errors and stop the build.
-### Read more about allocator
-### J - Use the JEMalloc allocator
-### GOOGLE to Use Google TCMalloc aka the allocator
-### LF - lfalloc to Use the allocator
-### LOCKLESS - No info
-### B - Use the allocator balloc named Pyotr Popov and Anton Samokhvalov (from library/balloc)
-### Post Ethosce: https://ironpeter.at.yandex-team.ru/replies.xml?item_no=126
-### SYSTEM - No info
-### FAKE - No info
-### About the allocator in Arcadia: https://wiki.yandex-team.ru/arcadia/allocators/
+
+### @usage ALLOCATOR(Alloc) # Default: LF
+### Set allocator implementation for a program
+### This may only be specified for programs. Use inside LIBRARY ALLOCATOR() END() leads to errors and stop the build.
+### Available allocators are: "LF", "LF_YT", "LF_DBG", "J", "B", "BS", "GOOGLE", "LOCKLESS", "SYSTEM", "FAKE"
+### LF - lfalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/lfalloc)
+### LF_YT - Allocator selection for YT (https://a.yandex-team.ru/arc/trunk/arcadia/library/lfalloc/yt/ya.make)
+### LF_DBG - Debug allocator selection(https://a.yandex-team.ru/arc/trunk/arcadia/library/lfalloc/dbg/ya.make)
+### J - The JEMalloc allocator (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/jemalloc)
+### B - The balloc allocator named Pyotr Popov and Anton Samokhvalov
+### Discussion: https://ironpeter.at.yandex-team.ru/replies.xml?item_no=126
+### Code: https://a.yandex-team.ru/arc/trunk/arcadia/library/balloc
+### BS - The balloc allocator with leak sanitizer (https://a.yandex-team.ru/arc/trunk/arcadia/library/balloc/sanitize)
+### GOOGLE - Google TCMalloc (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/galloc)
+### LOCKLESS - Allocator based upon lockless queues (https://a.yandex-team.ru/arc/trunk/arcadia/library/malloc/lockless)
+### SYSTEM - Use target system allocator
+### FAKE - Don't link with any allocator
+### More about the allocator in Arcadia: https://wiki.yandex-team.ru/arcadia/allocators/
macro ALLOCATOR(Alloc) {
SET(ALLOCATOR $Alloc)
}
