From: Christoph Hellwig <hch-jcswGhMUV9g@public.gmane.org>
To: jgunthorpe-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org
Cc: linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: [PATCH 8/9] move srp_daemon documentation to Documentation/
Date: Mon, 19 Sep 2016 08:56:32 -0700 [thread overview]
Message-ID: <1474300593-31922-9-git-send-email-hch@lst.de> (raw)
In-Reply-To: <1474300593-31922-1-git-send-email-hch-jcswGhMUV9g@public.gmane.org>
And drop bits that are outdated or replaced by top-level Documentation.
Signed-off-by: Christoph Hellwig <hch-jcswGhMUV9g@public.gmane.org>
---
Documentation/ibsrpdm.md | 41 ++++++++++++++++++++++++
srp_daemon/README | 82 ------------------------------------------------
2 files changed, 41 insertions(+), 82 deletions(-)
create mode 100644 Documentation/ibsrpdm.md
delete mode 100644 srp_daemon/README
diff --git a/Documentation/ibsrpdm.md b/Documentation/ibsrpdm.md
new file mode 100644
index 0000000..0fc544d
--- /dev/null
+++ b/Documentation/ibsrpdm.md
@@ -0,0 +1,41 @@
+# Using ibsrpdm
+
+ibsrpdm is used for discovering and connecting to SRP SCSI targets on
+InfiniBand fabrics. These targets can be accessed with the InfiniBand SRP
+initiator module, "ib_srp," included in Linux kernels 2.6.15 and newer.
+
+To run ibsrpdm, the ib_umad module must be loaded, as well as an appropriate
+low-level driver for the installed IB hardware.
+
+With no command line parameters, ibsrpdm displays information about
+SRP targets in human-readable form:
+
+ # ibsrpdm
+ IO Unit Info:
+ port LID: 0009
+ port GID: fe800000000000000005ad00000013e9
+ change ID: 73b0
+ max controllers: 0x01
+
+ controller[ 1]
+ GUID: 0005ad00000013e7
+ vendor ID: 0005ad
+ device ID: 0005ad
+ IO class : 0100
+ ID: Topspin SRP/FC TCA
+ service entries: 2
+ service[ 0]: 0000000000000066 / SRP.T10:20030003BA27CC7A
+ service[ 1]: 0000000000000066 / SRP.T10:20030003BA27CF53
+
+With the "-c" flag, ibsrpdm displays information in a form that can be
+written to the kernel SRP initiators add_target file to connect to the
+SRP targets. For example:
+
+ # ibsrpdm -c
+ id_ext=20030003BA27CC7A,ioc_guid=0005ad00000013e7,dgid=fe800000000000000005ad00000013e9,pkey=ffff,service_id=0000000000000066
+ id_ext=20030003BA27CF53,ioc_guid=0005ad00000013e7,dgid=fe800000000000000005ad00000013e9,pkey=ffff,service_id=0000000000000066
+
+Given this, the command below will connect to the first target
+discovered from the first port of the local HCA device "mthca0":
+
+ # echo -n id_ext=20030003BA27CC7A,ioc_guid=0005ad00000013e7,dgid=fe800000000000000005ad00000013e9,pkey=ffff,service_id=0000000000000066 > /sys/class/infiniband_srp/srp-mthca0-1/add_target
diff --git a/srp_daemon/README b/srp_daemon/README
deleted file mode 100644
index c44f11c..0000000
--- a/srp_daemon/README
+++ /dev/null
@@ -1,82 +0,0 @@
-Introduction
-============
-
-srptools is a package of tools for discovering and connecting to SRP
-SCSI targets on InfiniBand fabrics. These targets can be accessed
-with the InfiniBand SRP initiator module, "ib_srp," included in Linux
-kernels 2.6.15 and newer.
-
-Using srptools
-==============
-
-srptools currently contains only a single executable, ibsrpdm. To run
-ibsrpdm, the ib_umad module must be loaded, as well as an appropriate
-low-level driver for the installed IB hardware -- for example,
-ib_mthca for a Mellanox HCA, ib_ipath for a QLogic HCA, or hcad_mod
-for an IBM eHCA.
-
-With no command line parameters, ibsrpdm displays information about
-SRP targets in human-readable form:
-
- # ibsrpdm
- IO Unit Info:
- port LID: 0009
- port GID: fe800000000000000005ad00000013e9
- change ID: 73b0
- max controllers: 0x01
-
- controller[ 1]
- GUID: 0005ad00000013e7
- vendor ID: 0005ad
- device ID: 0005ad
- IO class : 0100
- ID: Topspin SRP/FC TCA
- service entries: 2
- service[ 0]: 0000000000000066 / SRP.T10:20030003BA27CC7A
- service[ 1]: 0000000000000066 / SRP.T10:20030003BA27CF53
-
-With the "-c" flag, ibsrpdm displays information in a form that can be
-written to the kernel SRP initiators add_target file to connect to the
-SRP targets. For example:
-
- # ibsrpdm -c
- id_ext=20030003BA27CC7A,ioc_guid=0005ad00000013e7,dgid=fe800000000000000005ad00000013e9,pkey=ffff,service_id=0000000000000066
- id_ext=20030003BA27CF53,ioc_guid=0005ad00000013e7,dgid=fe800000000000000005ad00000013e9,pkey=ffff,service_id=0000000000000066
-
-Given this, the command below will connect to the first target
-discovered from the first port of the local HCA device "mthca0":
-
- # echo -n id_ext=20030003BA27CC7A,ioc_guid=0005ad00000013e7,dgid=fe800000000000000005ad00000013e9,pkey=ffff,service_id=0000000000000066 > /sys/class/infiniband_srp/srp-mthca0-1/add_target
-
-Reporting bugs
-==============
-
-Bugs should be reported to the OpenIB mailing list
-<openib-general-0P3JtQMG0aQdnm+yROfE0A@public.gmane.org>. In your bug report, please include:
-
- * Information about your system:
- - Linux distribution and version
- - Linux kernel and version
- - InfiniBand hardware and firmware version
- - ... any other relevant information
-
- * How to reproduce the bug.
-
- * If the bug is a crash, the exact output printed out when the crash
- occurred, including any kernel messages produced.
-
-Submitting patches
-==================
-
-Patches should also be submitted to the OpenIB mailing list
-<openib-general-0P3JtQMG0aQdnm+yROfE0A@public.gmane.org>. Please use unified diff form (the -u
-option to GNU diff), and include a good description of what your patch
-does and why it should be applied. If your patch fixes a bug, please
-make sure to describe the bug and how your fix works.
-
-Please include a change to the ChangeLog file (in standard GNU
-changelog format) as part of your patch.
-
-Make sure that your contribution can be licensed under the same
-license as the original code you are patching, and that you have all
-necessary permissions to release your work.
--
2.1.4
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2016-09-19 15:56 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-19 15:56 update rdma-plumbing Documentation Christoph Hellwig
[not found] ` <1474300593-31922-1-git-send-email-hch-jcswGhMUV9g@public.gmane.org>
2016-09-19 15:56 ` [PATCH 1/9] add reporting bugs and submitting patches sections to README.md Christoph Hellwig
2016-09-19 15:56 ` [PATCH 2/9] remove empty documentation files Christoph Hellwig
2016-09-19 15:56 ` [PATCH 3/9] remove README files in the provider directories Christoph Hellwig
2016-09-19 15:56 ` [PATCH 4/9] move rxe documentation to Documentation/ Christoph Hellwig
2016-09-19 15:56 ` [PATCH 5/9] move libibverbs " Christoph Hellwig
[not found] ` <1474300593-31922-6-git-send-email-hch-jcswGhMUV9g@public.gmane.org>
2016-09-19 17:02 ` Parav Pandit
2016-09-19 15:56 ` [PATCH 6/9] move libibcm " Christoph Hellwig
2016-09-19 15:56 ` [PATCH 7/9] move librdmacm " Christoph Hellwig
2016-09-19 15:56 ` Christoph Hellwig [this message]
2016-09-19 15:56 ` [PATCH 9/9] remove iwpmd/README Christoph Hellwig
2016-09-19 19:25 ` update rdma-plumbing Documentation Jason Gunthorpe
[not found] ` <20160919192550.GA7486-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-09-19 20:59 ` Christoph Hellwig
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=1474300593-31922-9-git-send-email-hch@lst.de \
--to=hch-jcswghmuv9g@public.gmane.org \
--cc=jgunthorpe-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org \
--cc=linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox