aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2012-12-22 16:18:11 +0200
committerEli Zaretskii2012-12-22 16:18:11 +0200
commit04d9b71ab79f7773d9dba27ae2388a9e9ca563d4 (patch)
tree51d4d1ab34f06a62e000e61fa0311ce7d23e19bd
parentcdb075396213de91d318dbb6739d1885453a910c (diff)
downloademacs-04d9b71ab79f7773d9dba27ae2388a9e9ca563d4.tar.gz
emacs-04d9b71ab79f7773d9dba27ae2388a9e9ca563d4.zip
Undocument the details of the string returned by file-acl.
doc/lispref/files.texi (File Attributes, Changing Files): Remove the details about the text returned by file-acl. Instead, just document that it is an opaque string meant to be used by set-file-acl.
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/files.texi36
2 files changed, 17 insertions, 25 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 8158a282a5c..d3182e9bf37 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,9 @@
12012-12-22 Eli Zaretskii <eliz@gnu.org>
2
3 * files.texi (File Attributes, Changing Files): Remove the details
4 about the text returned by file-acl. Instead, just document that
5 it is an opaque string meant to be used by set-file-acl.
6
12012-12-21 Chong Yidong <cyd@gnu.org> 72012-12-21 Chong Yidong <cyd@gnu.org>
2 8
3 * modes.texi (Auto Major Mode): Fix typo (Bug#13230). 9 * modes.texi (Auto Major Mode): Fix typo (Bug#13230).
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index 07709d4c392..fe9b126d4a2 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1356,31 +1356,17 @@ support, then the return value is @code{(nil nil nil nil)}.
1356@cindex ACL entries 1356@cindex ACL entries
1357 If Emacs has been compiled with @dfn{ACL} (access control list) 1357 If Emacs has been compiled with @dfn{ACL} (access control list)
1358support, you can use the function @code{file-acl} to retrieve a file's 1358support, you can use the function @code{file-acl} to retrieve a file's
1359ACL entries. The format is platform-specific; on GNU/Linux and BSD, 1359ACL entries. The interface implementation is platform-specific; on
1360Emacs uses the POSIX ACL interface, while on MS-Windows Emacs emulates 1360GNU/Linux and BSD, Emacs uses the POSIX ACL interface, while on
1361the POSIX ACL interface with native file security APIs. For the 1361MS-Windows Emacs emulates the POSIX ACL interface with native file
1362function @code{set-file-acl}, see @ref{Changing Files}. 1362security APIs.
1363 1363
1364@defun file-acl filename 1364@defun file-acl filename
1365This function returns the ACL entries of the file @var{filename}. 1365This function returns the ACL entries of the file @var{filename}. The
1366The return value is a string containing the textual representation of 1366return value is a platform-dependent string containing the textual
1367the ACL entries. On Posix hosts, it looks like this: 1367representation of the ACL entries. Don't use it for anything except
1368 1368passing it to the @code{set-file-acl} function (@pxref{Changing Files,
1369@example 1369set-file-acl}).
1370@group
1371user::rw-
1372group::r--
1373group:gnu:rwx
1374mask::rwx
1375other::r--
1376@end group
1377@end example
1378
1379@cindex security descriptor, file
1380@cindex SDDL, MS-Windows
1381On MS-Windows, the return value is a textual description of the file's
1382@dfn{security descriptor} in @acronym{SDDL}, the @dfn{Security
1383Descriptor Definition Language}.
1384 1370
1385If the file does not exist or is inaccessible, or if Emacs was unable to 1371If the file does not exist or is inaccessible, or if Emacs was unable to
1386determine the ACL entries, then the return value is @code{nil}. The 1372determine the ACL entries, then the return value is @code{nil}. The
@@ -1726,8 +1712,8 @@ SELinux support.
1726This function sets the ACL entries of the file @var{filename} to 1712This function sets the ACL entries of the file @var{filename} to
1727@var{acl-string}. @xref{File Attributes}, for a brief description of 1713@var{acl-string}. @xref{File Attributes}, for a brief description of
1728ACLs. The @var{acl-string} argument should be a string containing the 1714ACLs. The @var{acl-string} argument should be a string containing the
1729textual representation of the desired ACL entries in the format 1715textual representation of the desired ACL entries as returned by
1730appropriate for the ACL interface being used. 1716@code{file-acl} (@pxref{File Attributes, file-acl}).
1731@end defun 1717@end defun
1732 1718
1733@node File Names 1719@node File Names