File 0316-Remove-trace-specific-terms-from-docs-for-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0316-Remove-trace-specific-terms-from-docs-for-table-orie.patch of Package erlang (Revision c299f11dbd35366482a3c0e1f83a05c5)

Currently displaying revision c299f11dbd35366482a3c0e1f83a05c5 , Show latest

From 957f9ae644ae55a005b032e63e31021690292115 Mon Sep 17 00:00:00 2001
From: Chris Keele <dev@chriskeele.com>
Date: Thu, 19 Apr 2018 01:23:36 -0700
Subject: [PATCH] Remove trace-specific terms from docs for table-oriented
 matchspecs

This removes the matchspec instructions `is_seq_trace` and `get_tcw/0`
from the documentation for table-oriented matchspecs.

This is likely correct as both are already documented under "Functions
Allowed Only for Tracing", despite appearing in the list of possible
options for table specs.

The following observations further back this change up:

```erl
erlang:match_spec_test([whatever], [{'_', [], [{is_seq_trace}]}], trace).
%=> {ok,true,[],[]}
erlang:match_spec_test({whatever}, [{'_', [], [{is_seq_trace}]}], table).
%=> {error,[{error,"Special form 'is_seq_trace' used in wrong %dialect."}]}

erlang:match_spec_test([whatever], [{'_', [], [{get_tcw}]}], trace).
%=> {ok,true,[],[]}
erlang:match_spec_test({whatever}, [{'_', [], [{get_tcw}]}], table).
%=> {error,[{error,"Function get_tcw/0 cannot be called in this context."}]}
```
---
 erts/doc/src/match_spec.xml | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/erts/doc/src/match_spec.xml b/erts/doc/src/match_spec.xml
index 2a14f1e47b..869991443e 100644
--- a/erts/doc/src/match_spec.xml
+++ b/erts/doc/src/match_spec.xml
@@ -169,10 +169,9 @@
         <c><![CDATA[is_reference]]></c> | <c><![CDATA[is_tuple]]></c> |
         <c><![CDATA[is_map]]></c> | <c><![CDATA[is_binary]]></c> |
         <c><![CDATA[is_function]]></c> | <c><![CDATA[is_record]]></c> |
-        <c><![CDATA[is_seq_trace]]></c> | <c><![CDATA['and']]></c> |
-        <c><![CDATA['or']]></c> | <c><![CDATA['not']]></c> |
-        <c><![CDATA['xor']]></c> | <c><![CDATA['andalso']]></c> |
-        <c><![CDATA['orelse']]></c>
+        <c><![CDATA['and']]></c> | <c><![CDATA['or']]></c> |
+        <c><![CDATA['not']]></c> | <c><![CDATA['xor']]></c> |
+        <c><![CDATA['andalso']]></c> | <c><![CDATA['orelse']]></c>
       </item>
       <item>ConditionExpression ::= ExprMatchVariable | { GuardFunction } |
         { GuardFunction, ConditionExpression, ... } | TermConstruct
@@ -202,8 +201,7 @@
         <c><![CDATA['>=']]></c> | <c><![CDATA['<']]></c> |
         <c><![CDATA['=<']]></c> | <c><![CDATA['=:=']]></c> |
         <c><![CDATA['==']]></c> | <c><![CDATA['=/=']]></c> |
-        <c><![CDATA['/=']]></c> | <c><![CDATA[self]]></c> |
-        <c><![CDATA[get_tcw]]></c>
+        <c><![CDATA['/=']]></c> | <c><![CDATA[self]]></c>
       </item>
       <item>MatchBody ::= [ ConditionExpression, ... ]
       </item>
-- 
2.16.3

Places

File 0316-Remove-trace-specific-terms-from-docs-for-table-orie.patch of Package erlang (Revision c299f11dbd35366482a3c0e1f83a05c5)

Places