All of lore.kernel.org
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@telfort.nl>
To: util-linux@vger.kernel.org
Subject: [PATCH 2/2] hardlink: grammarize the main description in the man page
Date: Fri, 11 Mar 2022 17:23:38 +0100	[thread overview]
Message-ID: <20220311162338.4375-2-bensberg@telfort.nl> (raw)
In-Reply-To: <20220311162338.4375-1-bensberg@telfort.nl>

(Also hard-wrap the extremely long line to resonable widths,
so that later small changes are easier to observe in git.)

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 misc-utils/hardlink.1.adoc | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/misc-utils/hardlink.1.adoc b/misc-utils/hardlink.1.adoc
index 851bb285d..5e13fde19 100644
--- a/misc-utils/hardlink.1.adoc
+++ b/misc-utils/hardlink.1.adoc
@@ -22,9 +22,18 @@ hardlink - link multiple copies of a file
 
 == DESCRIPTION
 
-*hardlink* is a tool which replaces copies of a file with hardlinks or copy-on-write clones, therefore saving space.
-
-*hardlink* creates a binary tree from file sizes and after that, it compares files with the same sizes. There are two basic content comparison methods. *memcmp* method directly reads data blocks from files and compares them. The other method is based on checksums (like SHA256), in this case for each data block is calculated checksum by Linux kernel crypto API, and this checksum is stored in userspace and used for files comparison. For each file is also cached "intro" buffer (32 bytes), this buffer is used independently on the comparison method and requested cache-size and io-size. The "intro" buffer dramatically reduces operations with data content as files are very often different from the beginning.
+*hardlink* is a tool that replaces copies of a file with either hardlinks or copy-on-write
+clones, thus saving space.
+
+*hardlink* first creates a binary tree of file sizes and then compares the content of files
+that have the same size. There are two basic content comparison methods. The *memcmp* method
+directly reads data blocks from files and compares them. The other method is based on checksums
+(like SHA256); in this case for each data block a checksum is calculated by the Linux kernel
+crypto API, and this checksum is stored in userspace and used for file comparisons.
+
+For each file also an "intro" buffer (32 bytes) is cached. This buffer is used independently
+from the comparison method and requested cache-size and io-size. The "intro" buffer dramatically
+reduces operations with data content as files are very often different from the beginning.
 
 == OPTIONS
 
-- 
2.34.1


  reply	other threads:[~2022-03-11 16:28 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-11 16:23 [PATCH 1/2] hardlink: set all locale elements, so that messages will get translated Benno Schulenberg
2022-03-11 16:23 ` Benno Schulenberg [this message]
2022-03-13  9:29 [PATCH 2/2] hardlink: grammarize the main description in the man page Benno Schulenberg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220311162338.4375-2-bensberg@telfort.nl \
    --to=bensberg@telfort.nl \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.