From patchwork Thu Oct 20 15:33:54 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jarod Wilson X-Patchwork-Id: 9387229 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 8F78760487 for ; Thu, 20 Oct 2016 15:34:19 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7F53529CCF for ; Thu, 20 Oct 2016 15:34:19 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 73D9829CD1; Thu, 20 Oct 2016 15:34:19 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F33ED29CCF for ; Thu, 20 Oct 2016 15:34:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965314AbcJTPeM (ORCPT ); Thu, 20 Oct 2016 11:34:12 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50138 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S965337AbcJTPeD (ORCPT ); Thu, 20 Oct 2016 11:34:03 -0400 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 56A103F1F0; Thu, 20 Oct 2016 15:34:03 +0000 (UTC) Received: from hp-dl360pgen8-07.khw.lab.eng.bos.redhat.com (hp-dl360pgen8-07.khw.lab.eng.bos.redhat.com [10.16.184.47]) by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u9KFY1CW030071; Thu, 20 Oct 2016 11:34:02 -0400 From: Jarod Wilson To: linux-rdma@vger.kernel.org Cc: Jarod Wilson , Jason Gunthorpe Subject: [PATCH rdma-core v2 1/4] Install end user focused documentation files Date: Thu, 20 Oct 2016 11:33:54 -0400 Message-Id: <20161020153357.27286-2-jarod@redhat.com> In-Reply-To: <20161020153357.27286-1-jarod@redhat.com> References: <20161014192136.11731-1-jarod@redhat.com> <20161020153357.27286-1-jarod@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Thu, 20 Oct 2016 15:34:03 +0000 (UTC) Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP We recommend that all distros ship these. v2: installing README.md and MAINTAINERS as well. Suggested-by: Jarod Wilson Signed-off-by: Jason Gunthorpe Signed-off-by: Jarod Wilson --- 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