warn that it's emulating php-on-linux

related to issue locutusjs#395
divinity76 · Sep 22, 2020 · d07e688 · d07e688
1 parent 916f5b4
commit d07e688
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/php/exec/escapeshellarg.js b/src/php/exec/escapeshellarg.js
@@ -1,5 +1,8 @@
 module.exports = function escapeshellarg (arg) {
   //  discuss at: https://locutus.io/php/escapeshellarg/
+  // Warning: this function emulates escapeshellarg() for php-running-on-linux
+  // the function behaves differently when running on Windows, which is not covered by this code.
+  // 
   // original by: Felix Geisendoerfer (https://www.debuggable.com/felix)
   // improved by: Brett Zamir (https://brett-zamir.me)
   //   example 1: escapeshellarg("kevin's birthday")