From: Richard Jones <rjones@redhat.com>
Date: Mon, 19 Apr 2010 19:13:05 +0000 (+0100)
Subject: docs: Clarify documentation for mknod (RHBZ#582948).
X-Git-Tag: 1.2.3~3
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=94bb71624ec0d88550ea7ea6c1c86d2b8d2163ed;p=libguestfs.git

docs: Clarify documentation for mknod (RHBZ#582948).
(cherry picked from commit 42e43db927dac13da0afe6dba39708295eb06021)
---

diff --git a/src/generator.ml b/src/generator.ml
index 57aad4f..219ccc0 100755
--- a/src/generator.ml
+++ b/src/generator.ml
@@ -2977,6 +2977,14 @@ constants.  C<devmajor> and C<devminor> are the
 device major and minor numbers, only used when creating block
 and character special devices.
 
+Note that, just like L<mknod(2)>, the mode must be bitwise
+OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
+just creates a regular file).  These constants are
+available in the standard Linux header files, or you can use
+C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
+which are wrappers around this command which bitwise OR
+in the appropriate constant for you.
+
 The mode actually set is affected by the umask.");
 
   ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],