svn commit: r329949 - head/stand/lua

[Kyle Evans]

Author: kevans
Date: Sun Feb 25 05:14:06 2018
New Revision: 329949
URL: https://svnweb.freebsd.org/changeset/base/329949

Log:
  lualoader: Explain deviation from naming guidelines
  
  cli_execute is likely the only exception that we should make, due to it
  being a global. We don't really need other globals, so this won't really end
  up an epidemic.

Modified:
  head/stand/lua/cli.lua

Modified: head/stand/lua/cli.lua
==============================================================================
--- head/stand/lua/cli.lua	Sun Feb 25 05:00:54 2018	(r329948)
+++ head/stand/lua/cli.lua	Sun Feb 25 05:14:06 2018	(r329949)
@@ -69,6 +69,10 @@ end
 -- Declares a global function cli_execute that attempts to dispatch the
 -- arguments passed as a lua function. This gives lua a chance to intercept
 -- builtin CLI commands like "boot"
+-- This function intentionally does not follow our general naming guideline for
+-- functions. This is global pollution, but the clearly separated 'cli' looks
+-- more like a module indicator to serve as a hint of where to look for the
+-- corresponding definition.
 function cli_execute(...)
 	local argv = {...}
 	-- Just in case...