diff mbox

ndctl: Add some package dependency information to README.md

Message ID 1490991738-29637-1-git-send-email-linda.knippers@hpe.com (mailing list archive)
State New, archived
Headers show

Commit Message

Linda Knippers March 31, 2017, 8:22 p.m. UTC
Rather than discover the required packages as a result
of configure failures, provide some hints in advance.

Signed-off-by: Linda Knippers <linda.knippers@hpe.com>
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Dan Williams March 31, 2017, 8:39 p.m. UTC | #1
On Fri, Mar 31, 2017 at 1:22 PM, Linda Knippers <linda.knippers@hpe.com> wrote:
> Rather than discover the required packages as a result
> of configure failures, provide some hints in advance.
>

Perhaps we should just point people to the "BuildRequires" lines in:

    https://github.com/pmem/ndctl/blob/master/ndctl.spec.in

That's where the list of build dependencies is kept up to date. I'd
rather not track it in two places.
Linda Knippers March 31, 2017, 8:41 p.m. UTC | #2
On 03/31/2017 04:39 PM, Dan Williams wrote:
> On Fri, Mar 31, 2017 at 1:22 PM, Linda Knippers <linda.knippers@hpe.com> wrote:
>> Rather than discover the required packages as a result
>> of configure failures, provide some hints in advance.
>>
> 
> Perhaps we should just point people to the "BuildRequires" lines in:
> 
>     https://github.com/pmem/ndctl/blob/master/ndctl.spec.in
> 
> That's where the list of build dependencies is kept up to date. I'd
> rather not track it in two places.
> 
Yes, that probably would be better. I'll resend something.

-- ljk
diff mbox

Patch

diff --git a/README.md b/README.md
index 38fc050..e31fab4 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,12 @@  Build
 `make check`  
 `sudo make install`  
 
+There are a number of packages required for the build steps that may not be installed by default.  These will be found during the first two steps.
+
+While not a complete list, the packages required to build on Fedora include:
+autogen, libtool, asciidoc, xmlto, kmod-devel, systemd-devel,libuuid-devel, json-c-devel
+The OpenSUSE package list is similar.
+
 Documentation
 =============
 See the latest documentation for the NVDIMM kernel sub-system here: