Skip to content

doc: posix: update for POSIX_FILE_SYSTEM_R #81475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ycsin wants to merge 2 commits into from
Closed

doc: posix: update for POSIX_FILE_SYSTEM_R #81475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
352f9e6
doc: posix: option_groups: add section for POSIX_FILE_SYSTEM_R
ycsin Nov 16, 2024
efbd5e8
doc: release-notes-4.0: posix: update for _POSIX_THREAD_SAFE_FUNCTIONS
ycsin Nov 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/releases/release-notes-4.0.rst
View file
Open in desktop
Copy link
Contributor

@kartben kartben Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comment

Copy link
Member Author

@ycsin ycsin Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#76401 hmm...

Copy link
Contributor

@kartben kartben Nov 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, we discussed setting up some kind of CI check to catch these.

Original file line number Diff line number Diff line change
Expand Up @@ -1367,6 +1367,7 @@ Libraries / Subsystems

* :ref:`POSIX_DEVICE_IO <posix_option_group_device_io>`
* :ref:`POSIX_SIGNALS <posix_option_group_signals>`
* :ref:`POSIX_FILE_SYSTEM_R <posix_option_group_file_system_r>`

* Added support for the following Options:

Expand All @@ -1381,6 +1382,7 @@ Libraries / Subsystems
* :ref:`_POSIX_THREAD_SAFE_FUNCTIONS <posix_option_thread_safe_functions>` improvements:

* Support for :c:func:`asctime_r`, :c:func:`ctime_r`, and :c:func:`localtime_r`.
* Added stub for :c:func:`getpwnam_r`, :c:func:`getpwuid_r`, :c:func:`getgrgid_r` and :c:func:`getgrnam_r`.
Copy link
Member

@cfriedt cfriedt Nov 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is maybe Ok for a backport PR to v4.0.

However, looking into things a bit deeper, getpwnam_r(), getpwuid_r(), getgrgid_r(), and getgrnam_r() belong to a separate Option Group -
POSIX_SYSTEM_DATABASE_R. And the non-reentrant versions of these belong to the POSIX_SYSTEM_DATABASE Option Group, and _POSIX_THREAD_SAFE_FUNCTIONS is more of an Option / Feature Test Macro.

So really what we need here is a new Kconfig.system_database file with two new Kconfig options (same as the option group names).

_POSIX_THREAD_SAFE_FUNCTIONS should probably be a hidden Kconfig option that depends on other Kconfig values being enabled. Namely, CONFIG_POSIX_SYSTEM_DATABASE_R, CONFIG_POSIX_C_LANG_SUPPORT_R, CONFIG_POSIX_FILE_LOCKING, CONFIG_POSIX_FILE_SYSTEM_R.

And then of course modify the docs

https://pubs.opengroup.org/onlinepubs/9799919799/xrat/V4_subprofiles.html

Copy link
Member

@cfriedt cfriedt Nov 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the above should be in a separate PR.


* :ref:`POSIX_THREADS_BASE <posix_option_group_threads_base>` improvements:

Expand Down
13 changes: 13 additions & 0 deletions doc/services/portability/posix/option_groups/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,19 @@ Enable this option group with :kconfig:option:`CONFIG_POSIX_FILE_SYSTEM`.
unlink(), yes
utime(),

.. _posix_option_group_file_system_r:

POSIX_FILE_SYSTEM_R
+++++++++++++++++++

Enable this option with :kconfig:option:`CONFIG_POSIX_FILE_SYSTEM_R`.

.. csv-table:: POSIX_FILE_SYSTEM_R
:header: API, Supported
:widths: 50,10

readdir_r(), yes

.. _posix_option_group_mapped_files:

POSIX_MAPPED_FILES
Expand Down
Loading