File 1383-inets-services_info-doc-update.patch of Package erlang
From b44b28b295557400bfdc44cf81e4bf9b28b897ba Mon Sep 17 00:00:00 2001
From: Jakub Witczak <kuba@erlang.org>
Date: Tue, 15 Feb 2022 16:55:09 +0100
Subject: [PATCH] inets: services_info doc update
Documentation fix for inets:services_info/0, which now describes that Info might
be a Reason term() in case when {error, Reason} is returned as service info.
---
lib/inets/doc/src/inets.xml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/lib/inets/doc/src/inets.xml b/lib/inets/doc/src/inets.xml
index 014a026383..8f3933489d 100644
--- a/lib/inets/doc/src/inets.xml
+++ b/lib/inets/doc/src/inets.xml
@@ -71,11 +71,11 @@
<name>services_info() -> [{Service, Pid, Info}]</name>
<fsummary>Returns a list of currently running services where
each service is described by an <c>[{Option, Value}]</c>
- list.</fsummary>
+ list or Reason in case of an error.</fsummary>
<type>
<v>Service = service()</v>
<v>Pid = pid()</v>
- <v>Info = [{Option, Value}]</v>
+ <v>Info = [{Option, Value}] | Reason</v>
<v>Option = property()</v>
<v>Value = term()</v>
</type>
@@ -84,7 +84,8 @@
service is described by an <c>[{Option, Value}]</c> list. The
information in the list is specific for each service
and each service has probably its own info
- function that gives more details about the service.</p>
+ function that gives more details about the service. If specific service
+ info returns {error, Reason}, Info will contain Reason term.</p>
<marker id="service_names"></marker>
</desc>
--
2.34.1