libnbd/0009-generator-Add-link-to-documentation-in-libnbd.h.patch
Richard W.M. Jones f001a4af3f Add all upstream patches since 0.9.6 was released.
Package the ocaml bindings into a subpackage.
2019-08-03 15:35:41 +01:00

34 lines
1.1 KiB
Diff

From aa44163862c33cd261403ae2b875918582c872ce Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Sat, 3 Aug 2019 15:09:15 +0100
Subject: [PATCH 09/11] generator: Add link to documentation in <libnbd.h>
We do the same sort of thing in libguestfs. It helps people to find
the documentation if their first contact with the library is through
seeing the header file.
---
generator/generator | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/generator/generator b/generator/generator
index 4de79ca..25aeb00 100755
--- a/generator/generator
+++ b/generator/generator
@@ -3386,6 +3386,13 @@ let generate_include_libnbd_h () =
pr "#ifndef LIBNBD_H\n";
pr "#define LIBNBD_H\n";
pr "\n";
+ pr "/* This is the public interface to libnbd, a client library for\n";
+ pr " * accessing Network Block Device (NBD) servers.\n";
+ pr " *\n";
+ pr " * Please read the libnbd(3) and libnbd-api(3) manual pages to\n";
+ pr " * find out how to use this library.\n";
+ pr " */\n";
+ pr "\n";
pr "#include <stdbool.h>\n";
pr "#include <stdint.h>\n";
pr "#include <sys/socket.h>\n";
--
2.22.0