GNU bug report logs - #55984
26.3; Doc string of `chmod' / `set-file-modes'

Previous Next

Full log

View this message in rfc822 format

From: Robert Pluim <rpluim <at> gmail.com>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 55984 <at> debbugs.gnu.org
Subject: bug#55984: 26.3; Doc string of `chmod' / `set-file-modes'
Date: Wed, 15 Jun 2022 11:03:32 +0200

>>>>> On Tue, 14 Jun 2022 21:36:37 +0000, Drew Adams <drew.adams <at> oracle.com> said:

    Drew> Please consider mentioning in the doc string that the command prompts
    Drew> for the file name and (then for) the modes.  The doc currently says how
    Drew> the modes are read, but it doesn't say that the command reads the file
    Drew> name.

Passive voice as well. How about the following for emacs-28


diff --git a/src/fileio.c b/src/fileio.c
index 7d392e0de7..a240216dea 100644
--- a/src/fileio.c
+++ b/src/fileio.c
@@ -3510,8 +3510,9 @@ DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 3,
 Only the 12 low bits of MODE are used.  If optional FLAG is `nofollow',
 do not follow FILENAME if it is a symbolic link.
 
-Interactively, mode bits are read by `read-file-modes', which accepts
-symbolic notation, like the `chmod' command from GNU Coreutils.  */)
+Interactively, prompts for FILENAME, and reads MODE with
+`read-file-modes', which accepts symbolic notation, like the `chmod'
+command from GNU Coreutils.  */)
   (Lisp_Object filename, Lisp_Object mode, Lisp_Object flag)
 {
   CHECK_FIXNUM (mode);


Robert
-- 

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.