From 37379025248a8ff393b3dca47f101217a90ea648 Mon Sep 17 00:00:00 2001
From: Jim Meyering <jim@meyering.net>
Date: Thu, 6 Sep 2001 14:36:21 +0000
Subject: (join invocation): Describe the GNU extension to join, which does not
 require sorted input when the input contains no unpairable lines.

---
 doc/coreutils.texi | 30 ++++++++++++++++++++++++++----
 1 file changed, 26 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index e32c7bd9f..d55efdc7b 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -3928,12 +3928,34 @@ join [@var{option}]@dots{} @var{file1} @var{file2}
 @vindex LC_COLLATE
 Either @var{file1} or @var{file2} (but not both) can be @samp{-},
 meaning standard input.  @var{file1} and @var{file2} should be already
-sorted in increasing textual order on the join fields, using the
+sorted on the join fields.
+
+Normally, the sort order is that of the
 collating sequence specified by the @env{LC_COLLATE} locale.  Unless
-the @option{-t} option is given, the input should be sorted ignoring blanks at
+the @option{-t} option is given, the sort comparison ignores blanks at
 the start of the join field, as in @code{sort -b}.  If the
-@option{--ignore-case} option is given, lines should be sorted without
-regard to the case of characters in the join field, as in @code{sort -f}.
+@option{--ignore-case} option is given, the sort comparison ignores
+the case of characters in the join field, as in @code{sort -f}.
+
+However, as a GNU extension, if the input has no unpairable lines the
+sort order can be any order that considers two fields to be equal if and
+only if the sort comparison described above considers them to be equal.
+For example:
+
+@example
+$ cat file1
+a a1
+c c1
+b b1
+$ cat file2
+a a2
+c c2
+b b2
+$ join file1 file2
+a a1 a2
+c c1 c2
+b b1 b2
+@end example
 
 The defaults are: the join field is the first field in each line;
 fields in the input are separated by one or more blanks, with leading
-- 
cgit v1.2.3-54-g00ecf