Skip to content

Commit d9d0848

Browse files
committed
[DOC] Fix the description of rb_path_check
c.f. #20971
1 parent 723f31c commit d9d0848

File tree

1 file changed

+5
-2
lines changed
  • include/ruby/internal/intern

1 file changed

+5
-2
lines changed

include/ruby/internal/intern/hash.h

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,12 +287,15 @@ VALUE rb_hash_update_by(VALUE hash1, VALUE hash2, rb_hash_update_func *func);
287287
/* file.c */
288288

289289
/**
290-
* This function is mysterious. What it does is not immediately obvious. Also
291-
* what it does seems platform dependent.
290+
* If the PATH_SEPARATOR-separated list of directory names contains the name of
291+
* a world-writable directory, issue a warning for it. This may do nothing on
292+
* some platforms.
292293
*
293294
* @param[in] path A local path.
294295
* @retval 0 The "check" succeeded.
295296
* @retval otherwise The "check" failed.
297+
* @note This feature may be disabled by setting `ENABLE_PATH_CHECK`
298+
* macro to zero at compilation time.
296299
*/
297300
int rb_path_check(const char *path);
298301

0 commit comments

Comments
 (0)