mirrors
/
janet
mirror of https://github.com/janet-lang/janet
1
0
Fork 0
Code Issues 1 Releases Wiki Activity

Fix docstring.

This commit is contained in:
Calvin Rose 2022-08-02 14:58:32 -05:00
parent 2c927ea768
commit 5b2169e0d1
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/core/os.c
View File

@ -1121,8 +1121,8 @@ JANET_CORE_FN(os_spawn,
"Execute a program on the system and return a handle to the process. Otherwise, takes the " "Execute a program on the system and return a handle to the process. Otherwise, takes the "
"same arguments as `os/execute`. Does not wait for the process. " "same arguments as `os/execute`. Does not wait for the process. "
"For each of the :in, :out, and :err keys to the `env` argument, one " "For each of the :in, :out, and :err keys to the `env` argument, one "
"can also pass in the keyword `:pipe`" "can also pass in the keyword `:pipe` "
"to get streams for standard IO of the subprocess that can be read from and written to." "to get streams for standard IO of the subprocess that can be read from and written to. "
"The returned value `proc` has the fields :in, :out, :err, :return-code, and " "The returned value `proc` has the fields :in, :out, :err, :return-code, and "
"the additional field :pid on unix-like platforms. Use `(os/proc-wait proc)` to rejoin the " "the additional field :pid on unix-like platforms. Use `(os/proc-wait proc)` to rejoin the "
"subprocess or `(os/proc-kill proc)`.") { "subprocess or `(os/proc-kill proc)`.") {
@ -2036,23 +2036,23 @@ JANET_CORE_FN(os_open,
"Allowed flags are as follows:\n\n" "Allowed flags are as follows:\n\n"
" * :r - open this file for reading\n" " * :r - open this file for reading\n"
" * :w - open this file for writing\n" " * :w - open this file for writing\n"
" * :c - create a new file (O_CREATE)\n" " * :c - create a new file (O\\_CREATE)\n"
" * :e - fail if the file exists (O_EXCL)\n" " * :e - fail if the file exists (O\\_EXCL)\n"
" * :t - shorten an existing file to length 0 (O_TRUNC)\n\n" " * :t - shorten an existing file to length 0 (O\\_TRUNC)\n\n"
"Posix-only flags:\n\n" "Posix-only flags:\n\n"
" * :a - append to a file (O_APPEND)\n" " * :a - append to a file (O\\_APPEND)\n"
" * :x - O_SYNC\n" " * :x - O\\_SYNC\n"
" * :C - O_NOCTTY\n\n" " * :C - O\\_NOCTTY\n\n"
"Windows-only flags:\n\n" "Windows-only flags:\n\n"
" * :R - share reads (FILE_SHARE_READ)\n" " * :R - share reads (FILE\\_SHARE\\_READ)\n"
" * :W - share writes (FILE_SHARE_WRITE)\n" " * :W - share writes (FILE\\_SHARE\\_WRITE)\n"
" * :D - share deletes (FILE_SHARE_DELETE)\n" " * :D - share deletes (FILE\\_SHARE\\_DELETE)\n"
" * :H - FILE_ATTRIBUTE_HIDDEN\n" " * :H - FILE\\_ATTRIBUTE\\_HIDDEN\n"
" * :O - FILE_ATTRIBUTE_READONLY\n" " * :O - FILE\\_ATTRIBUTE\\_READONLY\n"
" * :F - FILE_ATTRIBUTE_OFFLINE\n" " * :F - FILE\\_ATTRIBUTE\\_OFFLINE\n"
" * :T - FILE_ATTRIBUTE_TEMPORARY\n" " * :T - FILE\\_ATTRIBUTE\\_TEMPORARY\n"
" * :d - FILE_FLAG_DELETE_ON_CLOSE\n" " * :d - FILE\\_FLAG\\_DELETE\\_ON\\_CLOSE\n"
" * :b - FILE_FLAG_NO_BUFFERING\n") { " * :b - FILE\\_FLAG\\_NO\\_BUFFERING\n") {
janet_arity(argc, 1, 3); janet_arity(argc, 1, 3);
const char *path = janet_getcstring(argv, 0); const char *path = janet_getcstring(argv, 0);
const uint8_t *opt_flags = janet_optkeyword(argv, argc, 1, (const uint8_t *) "r"); const uint8_t *opt_flags = janet_optkeyword(argv, argc, 1, (const uint8_t *) "r");