]> git.e2factory.org Git - e2factory.git/commitdiff
Remove comments about abort
authorTobias Ulmer <tu@emlix.com>
Wed, 8 May 2013 17:01:42 +0000 (19:01 +0200)
committerTobias Ulmer <tu@emlix.com>
Wed, 16 Nov 2016 13:58:55 +0000 (14:58 +0100)
Signed-off-by: Tobias Ulmer <tu@emlix.com>
generic/e2lib.lua

index 6432083121182672e39feceea3f7d288db9c9c1a..e69603fab997b45f043a5d7e3f13c768ee83cbdc 100644 (file)
@@ -935,8 +935,7 @@ function e2lib.read_extension_config()
     return extension, nil
 end
 
---- get the global configuration
--- this function always succeeds or aborts
+--- Get the global configuration.
 -- @return The global configuration, or false on error.
 -- @return Error object on failure.
 function e2lib.get_global_config()
@@ -1416,10 +1415,9 @@ function e2lib.mktempfile(template)
     return tmp
 end
 
---- remove a temporary file and remove it from the builtin list of
--- temporary files
--- This function always succeeds (or aborts immediately)
--- @param path
+--- Delete the temporary file and remove it from the builtin list of
+-- temporary files.
+-- @param tmpfile File name to remove (string).
 function e2lib.rmtempfile(tmpfile)
     for i,v in ipairs(e2lib.globals.tmpfiles) do
         if v == tmpfile then
@@ -1433,7 +1431,6 @@ end
 --- Create a temporary directory.
 -- The template string is passed to the mktemp tool, which replaces
 -- trailing X characters by some random string to create a unique name.
--- This function always succeeds (or aborts immediately).
 -- @param template string: template name (optional)
 -- @return Name of the directory (string) or false on error.
 -- @return Error object on failure.
@@ -1458,10 +1455,9 @@ function e2lib.mktempdir(template)
     return tmpdir
 end
 
---- Remove a temporary directory and remove it from the builtin list of
--- temporary directories.
--- This function always succeeds (or aborts immediately)
--- @param path
+--- Recursively delete the temporary directory and remove it from the builtin
+-- list of temporary directories.
+-- @param tmpdir Directory name to remove (string).
 function e2lib.rmtempdir(tmpdir)
     for i,v in ipairs(e2lib.globals.tmpdirs) do
         if v == tmpdir then