From: Giovanni Bajo <rasky@develer.com>
Date: Thu, 19 Sep 2019 20:34:06 +0000 (+0200)
Subject: cmd/compile: adjust top-level documentation of poset
X-Git-Tag: go1.14beta1~947
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=740d2c8c2250355d22a7c70698f55eeb6894d1ce;p=gostls13.git

cmd/compile: adjust top-level documentation of poset

Change-Id: I29e24c734e5e0041008771c805a0285aac3e02e5
Reviewed-on: https://go-review.googlesource.com/c/go/+/196598
Reviewed-by: David Chase <drchase@google.com>
---

diff --git a/src/cmd/compile/internal/ssa/poset.go b/src/cmd/compile/internal/ssa/poset.go
index 071297f8fa..b80b8bd6f0 100644
--- a/src/cmd/compile/internal/ssa/poset.go
+++ b/src/cmd/compile/internal/ssa/poset.go
@@ -106,17 +106,17 @@ type posetNode struct {
 // order so that if we know that A<B<C and later learn that A==D, Ordered will return
 // true for D<C.
 //
+// It is also possible to record inequality relations between nodes with SetNonEqual;
+// non-equality relations are not transitive, but they can still be useful: for instance
+// if we know that A<=B and later we learn that A!=B, we can deduce that A<B.
+// NonEqual can be used to check whether it is known that the nodes are different, either
+// because SetNonEqual was called before, or because we know that they are strictly ordered.
+//
 // poset will refuse to record new relations that contradict existing relations:
 // for instance if A<B<C, calling SetOrder for C<A will fail returning false; also
 // calling SetEqual for C==A will fail.
 //
-// It is also possible to record inequality relations between nodes with SetNonEqual;
-// given that non-equality is not transitive, the only effect is that a later call
-// to SetEqual for the same values will fail. NonEqual checks whether it is known that
-// the nodes are different, either because SetNonEqual was called before, or because
-// we know that they are strictly ordered.
-//
-// It is implemented as a forest of DAGs; in each DAG, if there is a path (directed)
+// poset is implemented as a forest of DAGs; in each DAG, if there is a path (directed)
 // from node A to B, it means that A<B (or A<=B). Equality is represented by mapping
 // two SSA values to the same DAG node; when a new equality relation is recorded
 // between two existing nodes,the nodes are merged, adjusting incoming and outgoing edges.