diff libinterp/corefcn/syscalls.cc @ 20233:b597bd161a5f stable

doc: Document that mkfifo's mode argument is in decimal (bug #45054). * dirfns.cc (Fmkdir): Document that umask is applied to the mode bits of a newly created directory. * file-io.cc (Ffopen): Document that umask is applied to the mode bits of a newly created file. * file-io.cc (Fumask): Add brief explanation of umask and UNIX permission bits. * syscalls.cc (Fmkfifo): Document that mode is in decimal and subject to umask processing.
author Rik <rik@octave.org>
date Sun, 17 May 2015 09:45:54 -0700
parents aa36fb998a4d
children d9f35ceff9e1
line wrap: on
line diff
--- a/libinterp/corefcn/syscalls.cc	Thu May 14 14:25:37 2015 -0700
+++ b/libinterp/corefcn/syscalls.cc	Sun May 17 09:45:54 2015 -0700
@@ -821,14 +821,18 @@
 
 DEFUNX ("mkfifo", Fmkfifo, args, ,
         "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} mkfifo (@var{name}, @var{mode})\n\
+@deftypefn  {Built-in Function} {@var{err} =} mkfifo (@var{name}, @var{mode})\n\
 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\
-Create a FIFO special file named @var{name} with file mode @var{mode}\n\
+Create a FIFO special file named @var{name} with file mode @var{mode}.\n\
+\n\
+@var{mode} is interpreted as a decimal number (@emph{not} octal) and is\n\
+subject to umask processing.  The final calculated mode is\n\
+@code{@var{mode} - @var{umask}}.\n\
 \n\
 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
 error message.\n\
-@seealso{pipe}\n\
+@seealso{pipe, umask}\n\
 @end deftypefn")
 {
   octave_value_list retval;