File 1235-kernel-Update-read_file_info-docs-about-sy... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1235-kernel-Update-read_file_info-docs-about-symlinks.patch of Package erlang (Revision 3aaa84d7d540d57752db68644dc4a4df)

Currently displaying revision 3aaa84d7d540d57752db68644dc4a4df , Show latest

From 965d1d4f9ba6fbd21d5839a9a21482933b863647 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Mon, 7 Jun 2021 08:50:02 +0200
Subject: [PATCH 1/3] kernel: Update read_file_info docs about symlinks

file:read_file_info follows all links, so it can never return
that a file is a symbolic link. However, read_link_info can of
course return a symbolic link and they use the same docs to
describe what can be returned. So we make it clear that link can
only be returned when read_link_info is called.

See #4917 for a bit more context.
---
 lib/kernel/doc/src/file.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml
index e4aa4a81de..42798530bd 100644
--- a/lib/kernel/doc/src/file.xml
+++ b/lib/kernel/doc/src/file.xml
@@ -1479,9 +1479,10 @@ f.txt: {person, "kalle", 25}.
 <item>
 Size of file in bytes.
 </item>
- <tag><c>type = device | directory | other | regular | symlink</c></tag>
+ <tag><c>type = device | directory | other | regular</c></tag>
 <item>
- The type of the file.
+ The type of the file. Can also contain <c>symlink</c> when returned
+ from <seealso marker="#read_link_info/1">read_link_info/1,2</seealso>.
 </item>
 <tag><c>access = read | write | read_write | none</c></tag>
 <item>
-- 
2.26.2

Places

File 1235-kernel-Update-read_file_info-docs-about-symlinks.patch of Package erlang (Revision 3aaa84d7d540d57752db68644dc4a4df)

Places