summaryrefslogtreecommitdiffstats
path: root/doc/man/8/ceph-diff-sorted.rst
blob: 99e9583363e9b41446d3fd6f34cc73b773608f4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
:orphan:

==========================================================
 ceph-diff-sorted -- compare two sorted files line by line
==========================================================

.. program:: ceph-diff-sorted

Synopsis
========

| **ceph-diff-sorted** *file1* *file2*

Description
===========

:program:`ceph-diff-sorted` is a simplifed *diff* utility optimized
for comparing two files with lines that are lexically sorted.

The output is simplified in comparison to that of the standard `diff`
tool available in POSIX systems. Angle brackets ('<' and '>') are used
to show lines that appear in one file but not the other. The output is
not compatible with the `patch` tool.

This tool was created in order to perform diffs of large files (e.g.,
containing billions of lines) that the standard `diff` tool cannot
handle efficiently. Knowing that the lines are sorted allows this to
be done efficiently with minimal memory overhead.

The sorting of each file needs to be done lexcially. Most POSIX
systems use the *LANG* environment variable to determine the `sort`
tool's sorting order. To sort lexically we would need something such
as:

        $ LANG=C sort some-file.txt >some-file-sorted.txt

Examples
========

Compare two files::

        $ ceph-diff-sorted fileA.txt fileB.txt

Exit Status
===========

When complete, the exit status will be set to one of the following:

0
  files same
1
  files different
2
  usage problem (e.g., wrong number of command-line arguments)
3
  problem opening input file
4
  bad file content (e.g., unsorted order or empty lines)


Availability
============

:program:`ceph-diff-sorted` is part of Ceph, a massively scalable,
open-source, distributed storage system.  Please refer to the Ceph
documentation at http://ceph.com/docs for more information.

See also
========

:doc:`rgw-orphan-list <rgw-orphan-list>`\(8)