RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 10:57:34 +00:00
Code Issues Activity Actions

Documentation: Update readlink.md to use LibFileSystem api

Browse source
This commit is contained in:
Cameron Youell 2023-03-27 00:39:52 +00:00 • committed by Andrew Kaster
parent 58af4c85a4
commit 86781f0c08
1 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Base/usr/share/man/man2/readlink.md
View file

@ -26,12 +26,12 @@ and sets `errno` to describe the error.
## Notes ## Notes
The underlying system call always returns the full size of the target path on The underlying system call always returns the full size of the target path on
success, not the number of bytes written. `Core::DeprecatedFile::read_link()` makes use success, not the number of bytes written. `FileSystem::read_link()` makes use
of this to provide an alternative way to read links that doesn't require the of this to provide an alternative way to read links that doesn't require the
caller to pick a buffer size and allocate a buffer straight up. caller to pick a buffer size and allocate a buffer straight up.
Since it's essentially impossible to guess the right buffer size for reading Since it's essentially impossible to guess the right buffer size for reading
links, it's strongly recommended that everything uses `Core::DeprecatedFile::read_link()` links, it's strongly recommended that everything uses `FileSystem::read_link()`
instead. instead.
## Examples ## Examples
@ -40,7 +40,7 @@ The following example demonstrates how one could implement an alternative
version of `getpid(2)` which reads the calling process ID from ProcFS: version of `getpid(2)` which reads the calling process ID from ProcFS:
```c++ ```c++
#include <LibCore/DeprecatedFile.h> #include <LibFileSystem/FileSystem.h>
#include <unistd.h> #include <unistd.h>
pid_t read_pid_using_readlink() pid_t read_pid_using_readlink()
@ -53,11 +53,9 @@ pid_t read_pid_using_readlink()
return atoi(buffer); return atoi(buffer);
} }
pid_t read_pid_using_core_file() ErrorOr<pid_t> read_pid_using_core_file()
{ {
auto target = Core::DeprecatedFile::read_link("/proc/self"); auto target = TRY(File::read_link("/proc/self"sv));
if (target.is_null())
return -1;
auto pid = target.to_uint(); auto pid = target.to_uint();
ASSERT(pid.has_value()); ASSERT(pid.has_value());
return pid.value(); return pid.value();