From 50f4c40bdb5667aa7053434dede2dd98f6f9e243 Mon Sep 17 00:00:00 2001
From: Benoit Germain <benoit.germain@ubisoft.com>
Date: Fri, 14 Jun 2024 17:11:36 +0200
Subject: Wording fix: parameter → argument
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 deep_test/deep_test.cpp  |  2 +-
 deep_test/deeptest.lua   |  2 +-
 docs/index.html          | 12 ++++++------
 make-vc.cmd              |  2 +-
 src/cancel.cpp           |  2 +-
 src/intercopycontext.cpp |  4 ++--
 src/keeper.cpp           |  4 ++--
 src/lane.cpp             |  2 +-
 src/lane.h               |  2 +-
 src/lanes.cpp            |  2 +-
 src/lanes.lua            | 14 +++++++-------
 tests/argtable.lua       |  8 ++++----
 tests/assert.lua         |  6 +++---
 tests/cyclic.lua         |  4 ++--
 tests/finalizer.lua      |  2 +-
 tests/objects.lua        |  2 +-
 16 files changed, 35 insertions(+), 35 deletions(-)

diff --git a/deep_test/deep_test.cpp b/deep_test/deep_test.cpp
index 7e16b2e..c071dc6 100644
--- a/deep_test/deep_test.cpp
+++ b/deep_test/deep_test.cpp
@@ -208,7 +208,7 @@ struct MyClonableUserdata
         return 0;
 
     default:
-        raise_luaL_error(L, "Lanes called clonable_lanesclone with unexpected parameters");
+        raise_luaL_error(L, "Lanes called clonable_lanesclone with unexpected arguments");
     }
     return 0;
 }
diff --git a/deep_test/deeptest.lua b/deep_test/deeptest.lua
index 1c34cf8..de282a1 100644
--- a/deep_test/deeptest.lua
+++ b/deep_test/deeptest.lua
@@ -78,7 +78,7 @@ local performTest = function( obj_)
 	assert(_n == (_val2 and 2 or 1))
 	printDeep( "out of linda:", _val1, _val2)
 
-	-- send the object in a lane through parameter passing, the lane body returns it as return value, read the contents
+	-- send the object in a lane through argument passing, the lane body returns it as return value, read the contents
 	local g = lanes.gen(
 		"package"
 		, {
diff --git a/docs/index.html b/docs/index.html
index 06ce610..defb0ad 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1137,7 +1137,7 @@
 <p>
 	Communications between lanes is completely detached from the lane handles themselves. By itself, a lane can only provide return values once it is finished, or throw an error.
 	Needs to communicate during runtime are handled by <a href="http://en.wikipedia.org/wiki/Linda_%28coordination_language%29" target="_blank">Linda objects</a>, which are
-	<a href="#deep_userdata">deep userdata</a> instances. They can be provided to a lane as startup parameters, upvalues or in some other Linda's message.
+	<a href="#deep_userdata">deep userdata</a> instances. They can be provided to a lane as startup arguments, upvalues or in some other Linda's message.
 </p>
 
 <p>
@@ -1175,7 +1175,7 @@
 
 	<ul>
 		<li>Keys can be of boolean, number, string or light userdata type. Tables and functions can't be keys because their identity isn't preserved when transfered from one Lua state to another.</li>
-		<li>values can be any type supported by inter-state copying (same <a href="#limitations">limits</a> as for function parameters and upvalues).</li>
+		<li>values can be any type supported by inter-state copying (same <a href="#limitations">limits</a> as for function arguments and upvalues).</li>
 		<li>consuming method is <tt>:receive</tt> (not in).</li>
 		<li>non-consuming method is <tt>:get</tt> (not rd).</li>
 		<li>two producer-side methods: <tt>:send</tt> and <tt>:set</tt> (not out).</li>
@@ -1539,7 +1539,7 @@ On the other side, you need to use a common Linda for waiting for multiple keys.
 <h3>Limitations on data passing</h3>
 
 <p>
-	Data passed between lanes (either as starting parameters, return values, upvalues or via Lindas) must conform to the following:
+	Data passed between lanes (either as starting arguments, return values, upvalues or via Lindas) must conform to the following:
 	<ul>
 		<li>Coroutines cannot be passed. A coroutine's Lua state is tied to the Lua state that created it, and there is no way the mixed C/Lua stack of a coroutine can be transfered from one Lua state to another.</li>
 		<li>Lane handles cannot be passed between lanes.</li>
@@ -1685,7 +1685,7 @@ static int clonable_lanesclone(lua_State* L)
 		return 0;
 
 		default:
-		std::ignore = luaL_error(L, "Lanes called clonable_lanesclone with unexpected parameters");
+		std::ignore = luaL_error(L, "Lanes called clonable_lanesclone with unexpected arguments");
 	}
 	return 0;
 }
@@ -1800,7 +1800,7 @@ static MyDeepFactory g_MyDeepFactory;
 <h3>Beware with print and file output</h3>
 
 <p>
-	In multithreaded scenarios, giving multiple parameters to <tt>print()</tt> or <tt>file:write()</tt> may cause them to be overlapped in the output, something like this:
+	In multithreaded scenarios, giving multiple arguments to <tt>print()</tt> or <tt>file:write()</tt> may cause them to be overlapped in the output, something like this:
 
 <table border="1" bgcolor="#FFFFE0" cellpadding="10" style="width:50%"><tr><td><pre>
 	A:  print(1, 2, 3, 4 )
@@ -1821,7 +1821,7 @@ static MyDeepFactory g_MyDeepFactory;
 
 <p>
 	<ul>
-		<li>Data passing (parameters, upvalues, <a href="#lindas">Linda</a> messages) is generally fast, doing two binary state-to-state copies (from source state to hidden state, hidden state to target state). Remember that not only the function you specify but also its upvalues, their upvalues, etc. etc. will get copied.</li>
+		<li>Data passing (arguments, upvalues, <a href="#lindas">Linda</a> messages) is generally fast, doing two binary state-to-state copies (from source state to hidden state, hidden state to target state). Remember that not only the function you specify but also its upvalues, their upvalues, etc. etc. will get copied.</li>
 		<li>Lane startup is fast (1000's of lanes a second), depending on the number of standard libraries initialized. Initializing all standard libraries is about 3-4 times slower than having no standard libraries at all. If you throw in a lot of lanes per second, make sure you give them minimal necessary set of libraries.</li>
 		<li>Waiting Lindas are woken up (and execute some hidden Lua code) each time <u>any</u> key in the <a href="#lindas">Lindas</a> they are waiting for are changed. This may give essential slow-down (not measured, just a gut feeling) if a lot of <a href="#lindas">Linda</a> keys are used. Using separate <a href="#lindas">Lindas</a> for logically separate issues will help (which is good practice anyhow).</li>
 		<li><a href="#lindas">Linda</a> objects are light. The memory footprint is two OS-level signalling objects (<tt>HANDLE</tt> or <tt>pthread_cond_t</tt>) for each, plus one C pointer for the proxies per each Lua state using the <a href="#lindas">Linda</a>. Barely nothing.</li>
diff --git a/make-vc.cmd b/make-vc.cmd
index f4cd412..c50db3f 100644
--- a/make-vc.cmd
+++ b/make-vc.cmd
@@ -215,7 +215,7 @@ REM ---
 REM NOTE: 'timeit' is a funny thing; it does _not_ work with quoted
 REM long paths, but it _does_ work without the quotes. I have no idea,
 REM how it knows the spaces in paths apart from spaces in between
-REM parameters.
+REM arguments.
 
 :LAUNCHTEST
 timeit %LUA_EXE% tests\launchtest.lua %2 %3 %4
diff --git a/src/cancel.cpp b/src/cancel.cpp
index 990f5d4..755215f 100644
--- a/src/cancel.cpp
+++ b/src/cancel.cpp
@@ -168,7 +168,7 @@ LUAG_FUNC(thread_cancel)
     bool _wake_lane{ _op != CancelOp::Soft };
     if (lua_gettop(L_) >= 2) {
         if (!lua_isboolean(L_, 2)) {
-            raise_luaL_error(L_, "wake_lindas parameter is not a boolean");
+            raise_luaL_error(L_, "wake_lindas argument is not a boolean");
         }
         _wake_lane = lua_toboolean(L_, 2);
         lua_remove(L_, 2); // argument is processed, remove it
diff --git a/src/intercopycontext.cpp b/src/intercopycontext.cpp
index 34a1c95..85c1ebb 100644
--- a/src/intercopycontext.cpp
+++ b/src/intercopycontext.cpp
@@ -193,7 +193,7 @@ void InterCopyContext::copyFunction() const
     // "value returned is the error code returned by the last call
     // to the writer" (and we only return 0)
     // not sure this could ever fail but for memory shortage reasons
-    // last parameter is Lua 5.4-specific (no stripping)
+    // last argument is Lua 5.4-specific (no stripping)
     luaL_Buffer B{};
     if (luaG_dump(L1, buf_writer, &B, U->stripFunctions) != 0) {
         raise_luaL_error(getErrL(), "internal error: function dump failed.");
@@ -482,7 +482,7 @@ void InterCopyContext::interCopyKeyValuePair() const
         return;
         // we could raise an error instead of ignoring the table entry, like so:
         // raise_luaL_error(L1, "Unable to copy %s key '%s' because of value is of type '%s'", (vt == VT::NORMAL) ? "table" : "metatable", name, luaL_typename(L1, key_i));
-        // maybe offer this possibility as a global configuration option, or a linda setting, or as a parameter of the call causing the transfer?
+        // maybe offer this possibility as a global configuration option, or a linda setting, or as a argument of the call causing the transfer?
     }
 
     char* _valPath{ nullptr };
diff --git a/src/keeper.cpp b/src/keeper.cpp
index 7038f2c..e058114 100644
--- a/src/keeper.cpp
+++ b/src/keeper.cpp
@@ -576,8 +576,8 @@ int keepercall_set(lua_State* const L_)
  * Call a function ('func_name') in the keeper state, and pass on the returned
  * values to 'L'.
  *
- * 'linda':          deep Linda pointer (used only as a unique table key, first parameter)
- * 'starting_index': first of the rest of parameters (none if 0)
+ * 'linda':          deep Linda pointer (used only as a unique table key, first argument)
+ * 'starting_index': first of the rest of arguments (none if 0)
  *
  * Returns: number of return values (pushed to 'L'), unset in case of error
  */
diff --git a/src/lane.cpp b/src/lane.cpp
index e801cba..d4175c6 100644
--- a/src/lane.cpp
+++ b/src/lane.cpp
@@ -539,7 +539,7 @@ static void push_stack_trace(lua_State* L_, Lane::ErrorTraceLevel errorTraceLeve
 
 // #################################################################################################
 //---
-// Run finalizers - if any - with the given parameters
+// Run finalizers - if any - with the given arguments
 //
 // If 'rc' is nonzero, error message and stack index (the latter only when errorTraceLevel_ == 1) are available as:
 //      [-1]: stack trace (table)
diff --git a/src/lane.h b/src/lane.h
index 4461b37..0426240 100644
--- a/src/lane.h
+++ b/src/lane.h
@@ -14,7 +14,7 @@ static constexpr RegistryUniqueKey kExtendedStackTraceRegKey{ 0x38147AD48FB426E2
  * of functions that Lanes will call after the executing 'pcall' has ended.
  *
  * We're NOT using the GC system for finalizer mainly because providing the
- * error (and maybe stack trace) parameters to the finalizer functions would
+ * error (and maybe stack trace) arguments to the finalizer functions would
  * anyways complicate that approach.
  */
 // xxh64 of string "kFinalizerRegKey" generated at https://www.pelock.com/products/hash-calculator
diff --git a/src/lanes.cpp b/src/lanes.cpp
index f1aa873..cab5944 100644
--- a/src/lanes.cpp
+++ b/src/lanes.cpp
@@ -217,7 +217,7 @@ LUAG_FUNC(register)
 {
     std::string_view const _name{ luaG_checkstring(L_, 1) };
     LuaType const _mod_type{ luaG_type(L_, 2) };
-    // ignore extra parameters, just in case
+    // ignore extra arguments, just in case
     lua_settop(L_, 2);
     luaL_argcheck(L_, (_mod_type == LuaType::TABLE) || (_mod_type == LuaType::FUNCTION), 2, "unexpected module type");
     DEBUGSPEW_CODE(Universe* _U = Universe::Get(L_));
diff --git a/src/lanes.lua b/src/lanes.lua
index c860ba0..29fc4a9 100644
--- a/src/lanes.lua
+++ b/src/lanes.lua
@@ -158,12 +158,12 @@ local params_checker = function(settings_)
     -- make a copy of the table to leave the provided one unchanged, *and* to help ensure it won't change behind our back
     local settings = {}
     if type(settings_) ~= "table" then
-        error "Bad parameter #1 to lanes.configure(), should be a table"
+        error "Bad argument #1 to lanes.configure(), should be a table"
     end
     -- any setting unknown to Lanes raises an error
     for setting, _ in pairs(settings_) do
         if not param_checkers[setting] then
-        error("Unknown parameter '" .. setting .. "' in configure options")
+        error("Unknown argument '" .. setting .. "' in configure options")
         end
     end
     -- any setting not present in the provided parameters takes the default value
@@ -176,7 +176,7 @@ local params_checker = function(settings_)
             param = default_params[key]
         end
         if not checker(param) then
-            error("Bad parameter " .. key .. ": " .. tostring(param), 2)
+            error("Bad argument " .. key .. ": " .. tostring(param), 2)
         end
         settings[key] = param
     end
@@ -291,7 +291,7 @@ local opt_validators =
 --
 --        ... (more options may be introduced later) ...
 --
--- Calling with a function parameter ('lane_func') ends the string/table
+-- Calling with a function argument ('lane_func') ends the string/table
 -- modifiers, and prepares a lane generator.
 
 -- receives a sequence of strings and tables, plus a function
@@ -306,7 +306,7 @@ local gen = function(...)
 
     -- we need at least a function
     if n == 0 then
-        error("No parameters!", 2)
+        error("No arguments!", 2)
     end
 
     -- all arguments but the last must be nil, strings, or tables
@@ -322,7 +322,7 @@ local gen = function(...)
         elseif v == nil then
             -- skip
         else
-            error("Bad parameter " .. i .. ": " .. tv .. " " .. string_format("%q", tostring(v)), 2)
+            error("Bad argument " .. i .. ": " .. tv .. " " .. string_format("%q", tostring(v)), 2)
         end
     end
 
@@ -330,7 +330,7 @@ local gen = function(...)
     local func = select(n, ...)
     local functype = type(func)
     if functype ~= "function" and functype ~= "string" then
-        error("Last parameter not function or string: " .. functype .. " " .. string_format("%q", tostring(func)), 2)
+        error("Last argument not function or string: " .. functype .. " " .. string_format("%q", tostring(func)), 2)
     end
 
     -- check that the caller only provides reserved library names, and those only once
diff --git a/tests/argtable.lua b/tests/argtable.lua
index 5ed5d4e..95ee825 100644
--- a/tests/argtable.lua
+++ b/tests/argtable.lua
@@ -1,7 +1,7 @@
 --
 -- ARGTABLE.LUA            Copyright (c) 2007, Asko Kauppi <akauppi@gmail.com>
 --
--- Command line parameter parsing
+-- Command line argument parsing
 --
 -- NOTE: Wouldn't hurt having such a service built-in to Lua...? :P
 --
@@ -10,10 +10,10 @@ local m= {}
 
 -- tbl= argtable(...)
 --
--- Returns a table with 1..N indices being 'value' parameters, and any
--- "-flag[=xxx]" or "--flag[=xxx]" parameters set to { flag=xxx/true }.
+-- Returns a table with 1..N indices being 'value' arguments, and any
+-- "-flag[=xxx]" or "--flag[=xxx]" arguments set to { flag=xxx/true }.
 --
--- In other words, makes handling command line parameters simple. :)
+-- In other words, makes handling command line arguments simple. :)
 --
 --      15          -->     { 15 }
 --      -20         -->     { -20 }
diff --git a/tests/assert.lua b/tests/assert.lua
index 85febfb..7bb4233 100644
--- a/tests/assert.lua
+++ b/tests/assert.lua
@@ -6,7 +6,7 @@
 --
 -- This module allows shorthand use s.a. 'assert.table()' for asserting 
 -- variable types, and is also being used by Lua-super constraints system
--- for testing function parameter & return types.
+-- for testing function argument & return types.
 --
 -- All in all, a worthy module and could be part of Lua future versions.
 --
@@ -182,7 +182,7 @@ assert=
         return v
     end,
 
-    -- Range assertion, with extra parameters per instance
+    -- Range assertion, with extra arguments per instance
     -- 
     -- Note: values may be of _any_ type that can do >=, <= comparisons.
     --
@@ -240,7 +240,7 @@ assert=
             end
         end
         
-        _assert( type(tbl)=="table", "Wrong parameter to assert['{}']" )
+        _assert( type(tbl)=="table", "Wrong argument to assert['{}']" )
 
         return function( v, msg, lev )
             lev= (lev or 1)+1
diff --git a/tests/cyclic.lua b/tests/cyclic.lua
index fd6d4a0..ed4bdba 100644
--- a/tests/cyclic.lua
+++ b/tests/cyclic.lua
@@ -34,10 +34,10 @@ end
 local L1= lanes.gen( "io", lane1 )()
     -- ...running
 
--- Getting the tables as parameters should also keep the linkage
+-- Getting the tables as arguments should also keep the linkage
 --
 local function lane2( aa, bb )
-    WR( "Via parameters:", same(aa,bb[1]), same(aa[1],bb) )
+    WR( "Via arguments:", same(aa,bb[1]), same(aa[1],bb) )
     assert( aa[1]==bb )
     assert( bb[1]==aa )
     return true
diff --git a/tests/finalizer.lua b/tests/finalizer.lua
index 3158c65..1412a67 100644
--- a/tests/finalizer.lua
+++ b/tests/finalizer.lua
@@ -44,7 +44,7 @@ end
 
 -- 
 -- This is called at the end of the lane; whether succesful or not.
--- Gets the 'error()' parameter as parameter ('nil' if normal return).
+-- Gets the 'error()' argument as argument ('nil' if normal return).
 --
 cleanup = function(err)
     io.stderr:write "------------------------ In Worker Finalizer -----------------------\n"
diff --git a/tests/objects.lua b/tests/objects.lua
index 61c280d..ed460af 100644
--- a/tests/objects.lua
+++ b/tests/objects.lua
@@ -68,7 +68,7 @@ local mt_a= getmetatable(a)
 local mt_b= getmetatable(b)
 assert(mt_a and mt_a==mt_b )
 
-local h= start_lane(a)  -- 1st object as parameter
+local h= start_lane(a)  -- 1st object as argument
 
 linda:send("", b )    -- 2nd object via Linda
 
-- 
cgit v1.2.3-55-g6feb