[PATCH] manpage tgtadm : add description how to set/view digests

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Please find attached a patch to the manpage for tgtadm that adds a
section for how to view/set the digests on a target.

regards
ronnie sahlberg

Attachment: 0001-Manpage-tgtadm.patch.gz
Description: GNU Zip compressed data

From 9d3c5b7c560491d8331ac45e108aff72aef49610 Mon Sep 17 00:00:00 2001
From: Ronnie Sahlberg <sahlberg@lenovo-laptop.(none)>
Date: Tue, 14 Dec 2010 21:47:52 +1100
Subject: [PATCH] Manpage: tgtadm

Add a section to the tgtadm manpage on how to set and view
digests

Signed-off-by: Ronnie Sahlberg <sahlberg@lenovo-laptop.(none)>
---
 doc/manpages/tgtadm.8 |   41 +++++++++++++++++++++++++++++++++++++++--
 doc/tgtadm.8.xml      |   39 ++++++++++++++++++++++++++++++++++++---
 2 files changed, 75 insertions(+), 5 deletions(-)

diff --git a/doc/manpages/tgtadm.8 b/doc/manpages/tgtadm.8
index e61b558..cbf8f11 100644
--- a/doc/manpages/tgtadm.8
+++ b/doc/manpages/tgtadm.8
@@ -2,12 +2,12 @@
 .\"     Title: tgtadm
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 10/02/2010
+.\"      Date: 12/14/2010
 .\"    Manual: [FIXME: manual]
 .\"    Source: [FIXME: source]
 .\"  Language: English
 .\"
-.TH "TGTADM" "8" "10/02/2010" "[FIXME: source]" "[FIXME: manual]"
+.TH "TGTADM" "8" "12/14/2010" "[FIXME: source]" "[FIXME: manual]"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -405,6 +405,43 @@ tgtadm \-\-lld iscsi \-\-op new \-\-mode logicalunit \-\-tid 1 \-\-lun 1 \-\-bst
 .if n \{\
 .RE
 .\}
+.SH "HEADER DIGEST AND DATA DIGEST"
+.PP
+Header and data digests can be set on a per target parameter\&. TGTD supports two modes, None and CRC32C\&. When the digest is set to None, TDTD will negotiate that digests will not be used, and when CRC32C is set, TGTD will force the connection to use digest\&.
+.SS "Viewing the current settings"
+.PP
+This command is used to view the current settings for header/data digest\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+tgtadm \-\-op show \-\-mode target \-\-tid 1
+  \&.\&.\&.
+  HeaderDigest=None
+  DataDigest=None
+  \&.\&.\&.
+      
+.fi
+.if n \{\
+.RE
+.\}
+.SS "Setting digest"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Set header digest to CRC32C:
+tgtadm \-\-op update \-\-mode target \-\-tid 1 \-n HeaderDigest \-v CRC32C
+
+Set data digest to None:
+tgtadm \-\-op update \-\-mode target \-\-tid 1 \-n DataDigest \-v None
+      
+.fi
+.if n \{\
+.RE
+.\}
 .SH "ISNS PARAMETERS"
 .PP
 iSNS configuration for a target is by using the tgtadm command\&.
diff --git a/doc/tgtadm.8.xml b/doc/tgtadm.8.xml
index 2209fc7..455310f 100644
--- a/doc/tgtadm.8.xml
+++ b/doc/tgtadm.8.xml
@@ -497,6 +497,42 @@ tgtadm --lld iscsi --op new --mode logicalunit --tid 1 --lun 1 --bstype=sg --dev
   </refsect1>
 
 
+  <refsect1><title>Header Digest and Data Digest</title>
+    <para>
+      Header and data digests can be set on a per target parameter.
+      TGTD supports two modes, None and CRC32C.
+      When the digest is set to None, TDTD will negotiate that digests
+      will not be used, and when CRC32C is set, TGTD will force the
+      connection to use digest.
+    </para>
+
+    <refsect2><title>Viewing the current settings</title>
+      <para>
+	This command is used to view the current settings for header/data
+	digest.
+      </para>
+      <screen format="linespecific">
+tgtadm --op show --mode target --tid 1
+  ...
+  HeaderDigest=None
+  DataDigest=None
+  ...
+      </screen>
+    </refsect2>
+    <refsect2><title>Setting digest</title>
+      <screen format="linespecific">
+Set header digest to CRC32C:
+tgtadm --op update --mode target --tid 1 -n HeaderDigest -v CRC32C
+
+Set data digest to None:
+tgtadm --op update --mode target --tid 1 -n DataDigest -v None
+      </screen>
+    </refsect2>
+  </refsect1>
+
+
+
+
   <refsect1><title>iSNS PARAMETERS</title>
     <para>
       iSNS configuration for a target is by using the tgtadm command.
@@ -555,10 +591,7 @@ Example:
 
 tgtadm --op update --mode sys --name iSNSAccessControl --value Off
       </screen>
-
     </variablelist>
-
-
   </refsect1>
 
 
-- 
1.5.6


[Index of Archives]     [Linux SCSI]     [Linux RAID]     [Linux Clusters]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]

  Powered by Linux