[vlc-commits] [Git][videolan/vlc][master] vlc_waitpid: fix the documentation

[Jean-Baptiste Kempf (@jbk)]

Jean-Baptiste Kempf pushed to branch master at VideoLAN / VLC


Commits:
bdf0ec7b by Rémi Denis-Courmont at 2022-09-06T09:51:01+00:00
vlc_waitpid: fix the documentation

It is currently unspecified what happens if the process does not exit
cleanly, so clarify that. Since this can actually happen, the
documentation ought to state what the result is to some extent.

- - - - -


1 changed file:

- include/vlc_spawn.h


Changes:

=====================================
include/vlc_spawn.h
=====================================
@@ -84,7 +84,9 @@ int vlc_spawnp(pid_t *pid, const char *path, const int *fdv,
  *
  * \param pid process identifier as returned by vlc_spawn() or vlc_spawnp()
  *
- * \return This function returns the process exit code.
+ * \return If the process terminates cleanly, this function returns the exit
+ * code of the process. Otherwise, it returns an implementation-defined value
+ * that is not a valid exit code.
  */
 VLC_API
 int vlc_waitpid(pid_t pid);



View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/bdf0ec7b510121542c9e949cab7e40d036b992a8

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/bdf0ec7b510121542c9e949cab7e40d036b992a8
You're receiving this email because of your account on code.videolan.org.


VideoLAN code repository instance