Clarify documentation of (mis)features of osl_getExecutableFile()

Change-Id: I106b14a8ce2709c11f23eb1d49924c9c5ab51b50

1 files changed, 6 insertions, 0 deletions

diff --git a/include/osl/process.h b/include/osl/process.h
index ca30046af06d..f1fec5017b60 100644
--- a/include/osl/process.h
+++ b/include/osl/process.h
@@ -335,6 +335,12 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessInfo(
     @param strFile [out] the string that receives the executable file path.
     @return osl_Process_E_None or does not return.
     @see osl_executeProcess
+
+    Ideally this will return the true executable file path as a file:
+    URL, but actually in case something else happens to have been
+    passed as argv[0] to osl_setCommandArgs(), it will return that
+    either as a file URL, or as such in case it doesn't look like an
+    absolute pathname.
 */
 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getExecutableFile(
         rtl_uString **strFile);