]> git.wincent.com - mkdtemp.git/commitdiff
Clarify and re-format comments
authorWincent Colaiuta <win@wincent.com>
Sat, 27 Sep 2008 16:38:10 +0000 (18:38 +0200)
committerWincent Colaiuta <win@wincent.com>
Sat, 27 Sep 2008 16:38:10 +0000 (18:38 +0200)
Note that the template is overwritten in-place if supplied. Reformat for
better display in narrow terminals.

Signed-off-by: Wincent Colaiuta <win@wincent.com>
ext/mkdtemp.c

index 6a0b49a400d3e87913ba8da6a89f5d0dcf9cd3c3..822b299d54ef41050011aa49a4fefc48363b4e57 100644 (file)
@@ -23,18 +23,20 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 call-seq:
     Dir.mkdtemp([string])   -> String or nil
 
-This method securely creates temporary directories. It is a wrapper for the mkdtemp() function in the standard C library. It takes an optional String parameter as a template describing the desired form of the directory name; if no template is supplied then "/tmp/temp.XXXXXX" is used as a default.
+This method securely creates temporary directories. It is a wrapper for the mkdtemp() function in the standard C library. It takes
+an optional String parameter as a template describing the desired form of the directory name and overwriting the template in-place;
+if no template is supplied then "/tmp/temp.XXXXXX" is used as a default.
 
 */
 static VALUE walrus_dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
 {
     VALUE template;
-    if (rb_scan_args(argc, argv, "01", &template) == 0)                         /* check for 0 mandatory arguments, 1 optional argument */
-        template = Qnil;                                                        /* default to nil if no argument passed */
+    if (rb_scan_args(argc, argv, "01", &template) == 0  /* check for 0 mandatory arguments, 1 optional argument */
+        template = Qnil;                                /* default to nil if no argument passed */
     if (NIL_P(template))
-        template = rb_str_new2("/tmp/temp.XXXXXX");                             /* fallback to this template if passed nil */
-    SafeStringValue(template);                                                  /* raises if template is tainted and SAFE level > 0 */
-    VALUE safe  = StringValue(template);                                        /* duck typing support */
+        template = rb_str_new2("/tmp/temp.XXXXXX");     /* fallback to this template if passed nil */
+    SafeStringValue(template);                          /* raises if template is tainted and SAFE level > 0 */
+    VALUE safe  = StringValue(template);                /* duck typing support */
     char *path  = mkdtemp(RSTRING(safe)->ptr);
     if (path == NULL)
         rb_raise(rb_eSystemCallError, "mkdtemp failed (error: %d)", errno);
@@ -45,4 +47,3 @@ void Init_mkdtemp()
 {
     rb_define_module_function(rb_cDir, "mkdtemp", walrus_dir_mkdtemp_m, -1);
 }
-