From 1937c8e3f7860ff3dfbeb6d25dd434fcd3102ba8 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Wed, 20 Feb 2019 16:06:03 +0100
Subject: erts: Add enif_compare_pids

as a macro wrappper around enif_compare
---
 erts/doc/src/erl_nif.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'erts/doc/src/erl_nif.xml')

diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index ac873d0c8c..919f9f3245 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -1089,6 +1089,19 @@ typedef struct {
       </desc>
     </func>
 
+    <func>
+      <name since="OTP @OTP-15011@"><ret>int</ret><nametext>
+        enif_compare_pids(const ErlNifPid *pid1, const ErlNifPid *pid2)</nametext></name>
+      <fsummary>Compare two pids.</fsummary>
+      <desc>
+        <p>Compares two <seealso marker="#ErlNifPid"><c>ErlNifPid</c>
+	  </seealso>s according to term order.</p>
+        <p>Returns <c>0</c> if <c>pid1</c> and <c>pid2</c> are equal,
+          &lt; <c>0</c> if <c>pid1</c> &lt; <c>pid2</c>, and
+          &gt; <c>0</c> if <c>pid1</c> &gt; <c>pid2</c>.</p>
+      </desc>
+    </func>
+
     <func>
       <name since="OTP R13B04"><ret>void</ret>
         <nametext>enif_cond_broadcast(ErlNifCond *cnd)</nametext></name>
-- 
cgit v1.2.3