documents system.cmp's platform specific behaviour; fixes #8930

1 files changed, 2 insertions, 0 deletions

diff --git a/lib/system.nim b/lib/system.nim
index ef6138ad1..353500a4a 100644
--- a/lib/system.nim
+++ b/lib/system.nim
@@ -1237,6 +1237,8 @@ proc cmp*[T](x, y: T): int {.procvar.} =
 
 proc cmp*(x, y: string): int {.noSideEffect, procvar.}
   ## Compare proc for strings. More efficient than the generic version.
+  ## **Note**: The precise result values depend on the used C runtime library and
+  ## can differ between operating systems!
 
 proc `@`* [IDX, T](a: array[IDX, T]): seq[T] {.
   magic: "ArrToSeq", nosideeffect.}