All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jarod Wilson <jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
To: linux-rdma-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Cc: Jarod Wilson <jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>,
	Jason Gunthorpe
	<jgunthorpe-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
Subject: [PATCH rdma-core v2 1/4] Install end user focused documentation files
Date: Thu, 20 Oct 2016 11:33:54 -0400	[thread overview]
Message-ID: <20161020153357.27286-2-jarod@redhat.com> (raw)
In-Reply-To: <20161020153357.27286-1-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>

We recommend that all distros ship these.

v2: installing README.md and MAINTAINERS as well.

Suggested-by: Jarod Wilson <jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
Signed-off-by: Jason Gunthorpe <jgunthorpe-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
Signed-off-by: Jarod Wilson <jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
---
 CMakeLists.txt                   |  3 ++-
 Documentation/CMakeLists.txt     | 10 ++++++++++
 debian/ibacm.install             |  1 +
 debian/ibverbs-providers.install |  1 +
 debian/libibcm1.install          |  1 +
 debian/libibverbs1.install       |  1 +
 debian/librdmacm1.install        |  1 +
 debian/srptools.install          |  1 +
 rdma-core.spec                   |  6 +++++-
 9 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/CMakeLists.txt

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4d291d2..8dec772 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -21,7 +21,7 @@
 #      Use the historical search path for providers, in the standard system library.
 
 cmake_minimum_required(VERSION 2.8.11 FATAL_ERROR)
-project(RDMA C)
+project(rdma-core C)
 
 # CMake likes to use -rdynamic too much, they fixed it in 3.4.
 if(POLICY CMP0065)
@@ -259,6 +259,7 @@ configure_file("${BUILDLIB}/config.h.in" "${BUILD_INCLUDE}/config.h" ESCAPE_QUOT
 # Sub-directories
 add_subdirectory(ccan)
 add_subdirectory(util)
+add_subdirectory(Documentation)
 # Libraries
 add_subdirectory(libibumad)
 add_subdirectory(libibumad/man)
diff --git a/Documentation/CMakeLists.txt b/Documentation/CMakeLists.txt
new file mode 100644
index 0000000..6170b5f
--- /dev/null
+++ b/Documentation/CMakeLists.txt
@@ -0,0 +1,10 @@
+install(FILES
+  ibacm.md
+  ibsrpdm.md
+  libibcm.md
+  libibverbs.md
+  librdmacm.md
+  rxe.md
+  ../README.md
+  ../MAINTAINERS
+  DESTINATION "${CMAKE_INSTALL_DOCDIR}")
diff --git a/debian/ibacm.install b/debian/ibacm.install
index 2bb9591..f2a6c53 100644
--- a/debian/ibacm.install
+++ b/debian/ibacm.install
@@ -8,3 +8,4 @@ usr/share/man/man1/ib_acme.1
 usr/share/man/man1/ibacm.1
 usr/share/man/man7/ibacm.7
 usr/share/man/man7/ibacm_prov.7
+usr/share/doc/rdma-core/ibacm.md usr/share/doc/ibacm/
diff --git a/debian/ibverbs-providers.install b/debian/ibverbs-providers.install
index 1b41218..7458540 100644
--- a/debian/ibverbs-providers.install
+++ b/debian/ibverbs-providers.install
@@ -5,3 +5,4 @@ usr/lib/truescale-serdes.cmds
 usr/share/man/man8/rxe_cfg.8
 usr/share/man/man7/rxe.7
 usr/bin/rxe_cfg
+usr/share/doc/rdma-core/rxe.md usr/share/doc/ibverbs-providers/
diff --git a/debian/libibcm1.install b/debian/libibcm1.install
index 6f270b7..a0ace6e 100644
--- a/debian/libibcm1.install
+++ b/debian/libibcm1.install
@@ -1 +1,2 @@
 usr/lib/*/libibcm*.so.*
+usr/share/doc/rdma-core/libibcm.md usr/share/doc/libibcm1/
diff --git a/debian/libibverbs1.install b/debian/libibverbs1.install
index 78a7f76..83bdd80 100644
--- a/debian/libibverbs1.install
+++ b/debian/libibverbs1.install
@@ -1 +1,2 @@
 usr/lib/*/libibverbs*.so.*
+usr/share/doc/rdma-core/libibverbs.md usr/share/doc/libibverbs1/
diff --git a/debian/librdmacm1.install b/debian/librdmacm1.install
index c17048e..09140ab 100644
--- a/debian/librdmacm1.install
+++ b/debian/librdmacm1.install
@@ -1,2 +1,3 @@
 usr/lib/*/librdmacm*.so.*
 usr/lib/*/rsocket/librspreload*.so*
+usr/share/doc/rdma-core/librdmacm.md usr/share/doc/librdmacm1/
diff --git a/debian/srptools.install b/debian/srptools.install
index 17b909d..9c07015 100644
--- a/debian/srptools.install
+++ b/debian/srptools.install
@@ -6,3 +6,4 @@ usr/sbin/ibsrpdm
 usr/sbin/srp_daemon
 usr/share/man/man1/ibsrpdm.1
 usr/share/man/man1/srp_daemon.1
+usr/share/doc/rdma-core/ibsrpdm.md usr/share/doc/srptools/
diff --git a/rdma-core.spec b/rdma-core.spec
index 96c86fe..39be6a0 100644
--- a/rdma-core.spec
+++ b/rdma-core.spec
@@ -85,7 +85,8 @@ This is a simple example without the split sub packages to get things started.
          -DCMAKE_INSTALL_SYSCONFDIR:PATH=%{_sysconfdir} \
 	 -DCMAKE_INSTALL_SYSTEMD_SERVICEDIR:PATH=%{my_unitdir} \
 	 -DCMAKE_INSTALL_INITDDIR:PATH=%{_initrddir} \
-	 -DCMAKE_INSTALL_RUNDIR:PATH=%{_rundir}
+	 -DCMAKE_INSTALL_RUNDIR:PATH=%{_rundir} \
+	 -DCMAKE_INSTALL_DOCDIR:PATH=%{_docdir}/%{name}-%{version}
 %make_jobs
 
 %install
@@ -102,6 +103,8 @@ rm -rf %{buildroot}/%{my_unitdir}/
 
 %files
 %doc %{_mandir}/man*/*
+%doc %{_docdir}/%{name}-%{version}/README.md
+%doc %{_docdir}/%{name}-%{version}/MAINTAINERS
 %{_bindir}/*
 %{_includedir}/*
 %{_libdir}/lib*.so*
@@ -110,6 +113,7 @@ rm -rf %{buildroot}/%{my_unitdir}/
 %{_libdir}/rsocket/*
 %{_sbindir}/*
 %{_libexecdir}/*
+%{_docdir}/%{name}-%{version}/*
 %if 0%{?_unitdir:1}
 %{_unitdir}/*
 %else
-- 
2.10.0

--
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

  parent reply	other threads:[~2016-10-20 15:33 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-14 19:21 [PATCH rdma-core 0/4] rdma-core infrastructure Jarod Wilson
     [not found] ` <20161014192136.11731-1-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-14 19:21   ` [PATCH rdma-core 1/4] rpm spec: install documentation too Jarod Wilson
     [not found]     ` <20161014192136.11731-2-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-14 22:52       ` Jason Gunthorpe
     [not found]         ` <20161014225204.GB16509-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-17 15:53           ` Jarod Wilson
2016-10-14 19:21   ` [PATCH rdma-core 2/4] glue/redhat: add udev/systemd/etc infrastructure bits Jarod Wilson
     [not found]     ` <20161014192136.11731-3-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-14 23:19       ` Jason Gunthorpe
     [not found]         ` <20161014231934.GC16509-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-16 14:40           ` Doug Ledford
     [not found]             ` <1e03ceea-5584-6bbb-6fbe-e11d9d251649-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-17 17:31               ` Jason Gunthorpe
2016-10-17 16:22           ` Jarod Wilson
     [not found]             ` <20161017162221.GI14983-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-17 17:46               ` Jason Gunthorpe
     [not found]                 ` <20161017174611.GB6430-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-17 18:20                   ` Jarod Wilson
     [not found]                     ` <20161017182037.GK14983-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-17 18:56                       ` Doug Ledford
     [not found]                         ` <a6c8091e-fe83-8413-77d7-4aac053b8e62-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-17 19:14                           ` Jason Gunthorpe
2016-10-17 18:56                       ` Jason Gunthorpe
     [not found]                         ` <20161017185657.GA8122-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-17 19:10                           ` Weiny, Ira
     [not found]                             ` <2807E5FD2F6FDA4886F6618EAC48510E24F0A408-8k97q/ur5Z2krb+BlOpmy7fspsVTdybXVpNB7YpNyf8@public.gmane.org>
2016-10-17 20:13                               ` Jason Gunthorpe
     [not found]                                 ` <20161017201309.GA24291-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-18 14:51                                   ` Jarod Wilson
     [not found]                                     ` <20161018145104.GT14983-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-19 18:38                                       ` Weiny, Ira
     [not found]                                         ` <2807E5FD2F6FDA4886F6618EAC48510E24F0DF57-8k97q/ur5Z2krb+BlOpmy7fspsVTdybXVpNB7YpNyf8@public.gmane.org>
2016-10-19 18:59                                           ` Jason Gunthorpe
     [not found]                                             ` <20161019185920.GA20600-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-19 21:35                                               ` Weiny, Ira
     [not found]                                                 ` <2807E5FD2F6FDA4886F6618EAC48510E24F0E288-8k97q/ur5Z2krb+BlOpmy7fspsVTdybXVpNB7YpNyf8@public.gmane.org>
2016-10-19 22:55                                                   ` Weiny, Ira
2016-10-20  3:50                                                   ` Jason Gunthorpe
     [not found]                                                     ` <20161020035054.GB28678-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-20  4:20                                                       ` Weiny, Ira
2016-10-14 19:21   ` [PATCH rdma-core 3/4] glue/redhat: copy stock spec for RH customization Jarod Wilson
2016-10-14 19:21   ` [PATCH rdma-core 4/4] glue/redhat/spec: build split rpm packages Jarod Wilson
     [not found]     ` <20161014192136.11731-5-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-14 23:39       ` Jason Gunthorpe
     [not found]         ` <20161014233904.GD16509-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-17 18:45           ` Jarod Wilson
     [not found]             ` <20161017184506.GL14983-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-17 19:07               ` Jason Gunthorpe
     [not found]                 ` <20161017190705.GB8122-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-18 14:44                   ` Jarod Wilson
     [not found]                     ` <20161018144411.GS14983-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-18 19:28                       ` Jason Gunthorpe
2016-10-14 22:33   ` [PATCH rdma-core 0/4] rdma-core infrastructure Jason Gunthorpe
     [not found]     ` <20161014223308.GA16509-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-17 15:43       ` Jarod Wilson
2016-10-15  9:26   ` Leon Romanovsky
     [not found]     ` <20161015092619.GJ9282-2ukJVAZIZ/Y@public.gmane.org>
2016-10-17 15:51       ` Jarod Wilson
     [not found]         ` <20161017155159.GG14983-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-17 16:11           ` Jason Gunthorpe
     [not found]             ` <20161017161154.GB5679-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-17 16:26               ` Jarod Wilson
2016-10-20 15:33   ` [PATCH rdma-core v2 0/4] rdma-core redhat/ infrastructure Jarod Wilson
     [not found]     ` <20161020153357.27286-1-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-20 15:33       ` Jarod Wilson [this message]
2016-10-20 15:33       ` [PATCH rdma-core v2 2/4] redhat: add udev/systemd/etc infrastructure bits Jarod Wilson
2016-10-20 15:33       ` [PATCH rdma-core v2 3/4] redhat: copy stock spec for RH customization Jarod Wilson
2016-10-20 15:33       ` [PATCH rdma-core v2 4/4] redhat/spec: build split rpm packages Jarod Wilson
     [not found]         ` <20161020153357.27286-5-jarod-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-27 21:10           ` Jason Gunthorpe
     [not found]             ` <20161027211059.GA7224-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-28 17:11               ` Jarod Wilson
     [not found]                 ` <20161028171147.GJ42084-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-10-28 17:25                   ` Jason Gunthorpe
     [not found]                     ` <20161028172503.GA28451-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-10-28 20:57                       ` Jason Gunthorpe
2016-10-28 21:55                       ` Jarod Wilson
2016-11-03 20:35                   ` Doug Ledford
     [not found]                     ` <581B9F91.4050407-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2016-11-04  0:42                       ` Jason Gunthorpe
     [not found]                         ` <20161104004213.GA28485-ePGOBjL8dl3ta4EC/59zMFaTQe2KTcn/@public.gmane.org>
2016-11-07 17:23                           ` [PATCH rdma-core] redhat/spec: add back strict librdmacm Requires Jarod Wilson

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=20161020153357.27286-2-jarod@redhat.com \
    --to=jarod-h+wxahxf7alqt0dzr+alfa@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 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.