From 21ba9f7b4a0ccf0a20dd69f7ce81bb7eea699409 Mon Sep 17 00:00:00 2001
From: david <david@e0a8ed71-7df4-0310-8962-fdc924857419>
Date: Fri, 3 Aug 2012 02:08:44 +0000
Subject: [PATCH] Undocument nmap.sleep and undeprecate stdnse.sleep.

There are various functions in the internal nmap.socket and nmap.dnet
libraries that are there for technical reasons:
	http://seclists.org/nmap-dev/2012/q1/318
The sleep function is exposed through the stdnse namespace because it
fits that library better.

Some code comments said that names such as nmap.new_socket were
deprecated in favor of e.g. nmap.socket.new, but the old names were
never formally deprecated, so I removed those comments.
---
 nse_nmaplib.cc     | 24 ++++++++++++++++--------
 nselib/nmap.luadoc | 11 -----------
 nselib/stdnse.lua  |  7 ++++---
 3 files changed, 20 insertions(+), 22 deletions(-)

diff --git a/nse_nmaplib.cc b/nse_nmaplib.cc
index 0f2710135..94de0685f 100644
--- a/nse_nmaplib.cc
+++ b/nse_nmaplib.cc
@@ -936,10 +936,10 @@ int luaopen_nmap (lua_State *L)
     {"list_interfaces", l_list_interfaces},
     {"get_ttl", l_get_ttl},
     {"get_payload_length",l_get_payload_length},
-    {"new_dnet", nseU_placeholder}, /* deprecated, placeholder */
-    {"get_interface_info", nseU_placeholder}, /* deprecated, placeholder */
-    {"new_socket", nseU_placeholder}, /* deprecated, placeholder */
-    {"sleep", nseU_placeholder}, /* placeholder */
+    {"new_dnet", nseU_placeholder}, /* imported from nmap.dnet */
+    {"get_interface_info", nseU_placeholder}, /* imported from nmap.dnet */
+    {"new_socket", nseU_placeholder}, /* imported from nmap.socket */
+    {"sleep", nseU_placeholder}, /* imported from nmap.socket */
     {"mutex", nseU_placeholder}, /* placeholder */
     {"condvar", nseU_placeholder}, /* placeholder */
     {NULL, NULL}
@@ -959,18 +959,26 @@ int luaopen_nmap (lua_State *L)
   lua_newtable(L);
   lua_setfield(L, nmap_idx, "registry");
 
+  /* Pull out some functions from the nmap.socket and nmap.dnet libraries.
+     http://seclists.org/nmap-dev/2012/q1/299. */
   luaL_requiref(L, "nmap.socket", luaopen_nsock, 0);
+  /* nmap.socket.new -> nmap.new_socket. */
   lua_getfield(L, -1, "new");
-  lua_setfield(L, nmap_idx, "new_socket"); /* deprecated alias */
+  lua_setfield(L, nmap_idx, "new_socket");
+  /* nmap.socket.sleep -> nmap.sleep. */
   lua_getfield(L, -1, "sleep");
-  lua_setfield(L, nmap_idx, "sleep"); /* permanent alias */
+  lua_setfield(L, nmap_idx, "sleep");
+  /* Store nmap.socket; used by nse_main.lua. */
   lua_setfield(L, nmap_idx, "socket");
 
   luaL_requiref(L, "nmap.dnet", luaopen_dnet, 0);
+  /* nmap.dnet.new -> nmap.new_dnet. */
   lua_getfield(L, -1, "new");
-  lua_setfield(L, nmap_idx, "new_dnet"); /* deprecated alias */
+  lua_setfield(L, nmap_idx, "new_dnet");
+  /* nmap.dnet.get_interface_info -> nmap.get_interface_info. */
   lua_getfield(L, -1, "get_interface_info");
-  lua_setfield(L, nmap_idx, "get_interface_info"); /* deprecated alias */
+  lua_setfield(L, nmap_idx, "get_interface_info");
+  /* Store nmap.socket. */
   lua_setfield(L, nmap_idx, "dnet");
 
   lua_settop(L, nmap_idx);
diff --git a/nselib/nmap.luadoc b/nselib/nmap.luadoc
index f0ff9a8f3..c2f556a8a 100644
--- a/nselib/nmap.luadoc
+++ b/nselib/nmap.luadoc
@@ -795,14 +795,3 @@ function ip_close()
 -- debugging level.
 -- @see stdnse.print_debug
 function log_write(file, string)
-
---- Sleeps for a given amount of time.
---
--- This causes the program to yield control and not regain it until the time
--- period has elapsed. The time may have a fractional part. Internally, the
--- timer provides millisecond resolution.
--- @name sleep
--- @class function
--- @param t Time to sleep, in seconds.
--- @usage stdnse.sleep(1.5)
-function sleep (t)
diff --git a/nselib/stdnse.lua b/nselib/stdnse.lua
index cad26519d..be251c9a1 100644
--- a/nselib/stdnse.lua
+++ b/nselib/stdnse.lua
@@ -41,10 +41,11 @@ local EMPTY = {}; -- Empty constant table
 
 _ENV = require "strict" {};
 
---- (Deprecated Alias) Sleeps for a given amount of time.
---
--- Please use nmap.sleep instead.
+--- Sleeps for a given amount of time.
 --
+-- This causes the program to yield control and not regain it until the time
+-- period has elapsed. The time may have a fractional part. Internally, the
+-- timer provides millisecond resolution.
 -- @name sleep
 -- @class function
 -- @param t Time to sleep, in seconds.