From: Tobias Ulmer <tu@emlix.com>
Date: Fri, 18 Jan 2013 18:31:29 +0000 (+0100)
Subject: Remove unused e2lib.read_all() and fix documentation
X-Git-Tag: e2factory-2.3.13rc1~51
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=67f02418b7ebeccf41cba26a0038f10eb3769af0;p=e2factory.git

Remove unused e2lib.read_all() and fix documentation

Signed-off-by: Tobias Ulmer <tu@emlix.com>
---

diff --git a/generic/e2lib.lua b/generic/e2lib.lua
index c20a9fd..eef209c 100644
--- a/generic/e2lib.lua
+++ b/generic/e2lib.lua
@@ -745,17 +745,10 @@ function e2lib.howtounpack(physpath, virtpath, destdir)
     return tool, toolargv
 end
 
--- Input/Output operations
---
---   read_line(PATHNAME)
---
---     Reads a single line from the given file and returns it.
---
---   read_all(FD, [BLOCKSIZE]) -> STRING
---
---     Reads all remaining input from a given file-descriptor. BLOCKSIZE
---     specifies the size of subsequently read blocks and defaults to 1024.
-
+--- Read the first line from the given file and return it.
+-- @param path Path to file (string).
+-- @return The first line or nil on error.
+-- @return Error object on failure.
 function e2lib.read_line(path)
     local f, msg = io.open(path)
     if not f then
@@ -769,19 +762,6 @@ function e2lib.read_line(path)
     return l
 end
 
-function e2lib.read_all(fd, blocksize)
-    local input = {}
-    local blocksize = blocksize or 1024
-    while true do
-        local s, msg = e2util.read(fd, blocksize)
-        if not s then e2lib.bomb("read error: ", msg)
-        elseif #s == 0 then break
-        else table.insert(input, s) end
-    end
-    return table.concat(input)
-end
-
-
 -- Iterators
 --
 -- These iterators are convenience functions for use in "for" statements.