(Fdefine_key): Doc fix.
[bpt/emacs.git] / src / dired.c
index eb10f7f..54f96ba 100644 (file)
@@ -117,6 +117,8 @@ Lisp_Object Qfile_name_completion;
 Lisp_Object Qfile_name_all_completions;
 Lisp_Object Qfile_attributes;
 Lisp_Object Qfile_attributes_lessp;
+
+static int scmp P_ ((unsigned char *, unsigned char *, int));
 \f
 
 Lisp_Object
@@ -128,7 +130,7 @@ directory_files_internal_unwind (dh)
   return Qnil;
 }
 
-/* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.  
+/* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.
    When ATTRS is zero, return a list of directory filenames; when
    non-zero, return a list of directory filenames and their attributes.  */
 
@@ -142,7 +144,7 @@ directory_files_internal (directory, full, match, nosort, attrs)
   Lisp_Object list, dirfilename, encoded_directory;
   struct re_pattern_buffer *bufp = NULL;
   int needsep = 0;
-  int count = specpdl_ptr - specpdl;
+  int count = SPECPDL_INDEX ();
   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
   DIRENTRY *dp;
   int retry_p;
@@ -185,8 +187,8 @@ directory_files_internal (directory, full, match, nosort, attrs)
      have to make sure it gets closed, and setting up an
      unwind_protect to do so would be a pain.  */
  retry:
-  
-  d = opendir (XSTRING (dirfilename)->data);
+
+  d = opendir (SDATA (dirfilename));
   if (d == NULL)
     report_file_error ("Opening directory", Fcons (directory, Qnil));
 
@@ -197,13 +199,13 @@ directory_files_internal (directory, full, match, nosort, attrs)
                         Fcons (make_number (((unsigned long) d) >> 16),
                                make_number (((unsigned long) d) & 0xffff)));
 
-  directory_nbytes = STRING_BYTES (XSTRING (directory));
+  directory_nbytes = SBYTES (directory);
   re_match_object = Qt;
 
   /* Decide whether we need to add a directory separator.  */
 #ifndef VMS
   if (directory_nbytes == 0
-      || !IS_ANY_SEP (XSTRING (directory)->data[directory_nbytes - 1]))
+      || !IS_ANY_SEP (SREF (directory, directory_nbytes - 1)))
     needsep = 1;
 #endif /* not VMS */
 
@@ -217,7 +219,7 @@ directory_files_internal (directory, full, match, nosort, attrs)
       if (dp == NULL && errno == EAGAIN)
        continue;
 #endif
-      
+
       if (dp == NULL)
        break;
 
@@ -231,11 +233,11 @@ directory_files_internal (directory, full, match, nosort, attrs)
          len = NAMLEN (dp);
          name = finalname = make_unibyte_string (dp->d_name, len);
          GCPRO2 (finalname, name);
-         
+
          /* Note: ENCODE_FILE can GC; it should protect its argument,
             though.  */
          name = DECODE_FILE (name);
-         len = STRING_BYTES (XSTRING (name));
+         len = SBYTES (name);
 
          /* Now that we have unwind_protect in place, we might as well
              allow matching to be interrupted.  */
@@ -243,7 +245,7 @@ directory_files_internal (directory, full, match, nosort, attrs)
          QUIT;
 
          if (NILP (match)
-             || (0 <= re_search (bufp, XSTRING (name)->data, len, 0, len, 0)))
+             || (0 <= re_search (bufp, SDATA (name), len, 0, len, 0)))
            wanted = 1;
 
          immediate_quit = 0;
@@ -257,26 +259,26 @@ directory_files_internal (directory, full, match, nosort, attrs)
                  int nchars;
 
                  fullname = make_uninit_multibyte_string (nbytes, nbytes);
-                 bcopy (XSTRING (directory)->data, XSTRING (fullname)->data,
+                 bcopy (SDATA (directory), SDATA (fullname),
                         directory_nbytes);
-                 
+
                  if (needsep)
-                   XSTRING (fullname)->data[directory_nbytes] = DIRECTORY_SEP;
-                 
-                 bcopy (XSTRING (name)->data,
-                        XSTRING (fullname)->data + directory_nbytes + needsep,
+                   SSET (fullname, directory_nbytes, DIRECTORY_SEP);
+
+                 bcopy (SDATA (name),
+                        SDATA (fullname) + directory_nbytes + needsep,
                         len);
-                 
-                 nchars = chars_in_text (XSTRING (fullname)->data, nbytes);
+
+                 nchars = chars_in_text (SDATA (fullname), nbytes);
 
                  /* Some bug somewhere.  */
                  if (nchars > nbytes)
                    abort ();
-                     
-                 XSTRING (fullname)->size = nchars;
+
+                 STRING_SET_CHARS (fullname, nchars);
                  if (nchars == nbytes)
-                   SET_STRING_BYTES (XSTRING (fullname), -1);
-                 
+                   STRING_SET_UNIBYTE (fullname);
+
                  finalname = fullname;
                }
              else
@@ -326,20 +328,20 @@ directory_files_internal (directory, full, match, nosort, attrs)
   if (NILP (nosort))
     list = Fsort (Fnreverse (list),
                  attrs ? Qfile_attributes_lessp : Qstring_lessp);
-  
+
   RETURN_UNGCPRO (list);
 }
 
 
 DEFUN ("directory-files", Fdirectory_files, Sdirectory_files, 1, 4, 0,
-  "Return a list of names of files in DIRECTORY.\n\
-There are three optional arguments:\n\
-If FULL is non-nil, return absolute file names.  Otherwise return names\n\
- that are relative to the specified directory.\n\
-If MATCH is non-nil, mention only file names that match the regexp MATCH.\n\
-If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
- NOSORT is useful if you plan to sort the result yourself.")
-  (directory, full, match, nosort)
+       doc: /* Return a list of names of files in DIRECTORY.
+There are three optional arguments:
+If FULL is non-nil, return absolute file names.  Otherwise return names
+ that are relative to the specified directory.
+If MATCH is non-nil, mention only file names that match the regexp MATCH.
+If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
+ NOSORT is useful if you plan to sort the result yourself.  */)
+     (directory, full, match, nosort)
      Lisp_Object directory, full, match, nosort;
 {
   Lisp_Object handler;
@@ -363,15 +365,16 @@ If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
   return directory_files_internal (directory, full, match, nosort, 0);
 }
 
-DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes, Sdirectory_files_and_attributes, 1, 4, 0,
-  "Return a list of names of files and their attributes in DIRECTORY.\n\
-There are three optional arguments:\n\
-If FULL is non-nil, return absolute file names.  Otherwise return names\n\
- that are relative to the specified directory.\n\
-If MATCH is non-nil, mention only file names that match the regexp MATCH.\n\
-If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
- NOSORT is useful if you plan to sort the result yourself.")
-  (directory, full, match, nosort)
+DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes,
+       Sdirectory_files_and_attributes, 1, 4, 0,
+       doc: /* Return a list of names of files and their attributes in DIRECTORY.
+There are three optional arguments:
+If FULL is non-nil, return absolute file names.  Otherwise return names
+ that are relative to the specified directory.
+If MATCH is non-nil, mention only file names that match the regexp MATCH.
+If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
+ NOSORT is useful if you plan to sort the result yourself.  */)
+     (directory, full, match, nosort)
      Lisp_Object directory, full, match, nosort;
 {
   Lisp_Object handler;
@@ -399,16 +402,16 @@ If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
 Lisp_Object file_name_completion ();
 
 DEFUN ("file-name-completion", Ffile_name_completion, Sfile_name_completion,
-  2, 2, 0,
-  "Complete file name FILE in directory DIRECTORY.\n\
-Returns the longest string\n\
-common to all file names in DIRECTORY that start with FILE.\n\
-If there is only one and FILE matches it exactly, returns t.\n\
-Returns nil if DIR contains no name starting with FILE.\n\
-\n\
-This function ignores some of the possible completions as\n\
-determined by the variable `completion-ignored-extensions', which see.")
-  (file, directory)
+       2, 2, 0,
+       doc: /* Complete file name FILE in directory DIRECTORY.
+Returns the longest string
+common to all file names in DIRECTORY that start with FILE.
+If there is only one and FILE matches it exactly, returns t.
+Returns nil if DIR contains no name starting with FILE.
+
+This function ignores some of the possible completions as
+determined by the variable `completion-ignored-extensions', which see.  */)
+     (file, directory)
      Lisp_Object file, directory;
 {
   Lisp_Object handler;
@@ -429,10 +432,10 @@ determined by the variable `completion-ignored-extensions', which see.")
 }
 
 DEFUN ("file-name-all-completions", Ffile_name_all_completions,
-  Sfile_name_all_completions, 2, 2, 0,
-  "Return a list of all completions of file name FILE in directory DIRECTORY.\n\
-These are all file names in directory DIRECTORY which begin with FILE.")
-  (file, directory)
+       Sfile_name_all_completions, 2, 2, 0,
+       doc: /* Return a list of all completions of file name FILE in directory DIRECTORY.
+These are all file names in directory DIRECTORY which begin with FILE.  */)
+     (file, directory)
      Lisp_Object file, directory;
 {
   Lisp_Object handler;
@@ -470,7 +473,7 @@ file_name_completion (file, dirname, all_flag, ver_flag)
   struct stat st;
   int directoryp;
   int passcount;
-  int count = specpdl_ptr - specpdl;
+  int count = SPECPDL_INDEX ();
   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
 
   elt = Qnil;
@@ -516,10 +519,16 @@ file_name_completion (file, dirname, all_flag, ver_flag)
 
   for (passcount = !!all_flag; NILP (bestmatch) && passcount < 2; passcount++)
     {
-      d = opendir (XSTRING (Fdirectory_file_name (encoded_dir))->data);
+      int inner_count = SPECPDL_INDEX ();
+
+      d = opendir (SDATA (Fdirectory_file_name (encoded_dir)));
       if (!d)
        report_file_error ("Opening directory", Fcons (dirname, Qnil));
 
+      record_unwind_protect (directory_files_internal_unwind,
+                             Fcons (make_number (((unsigned long) d) >> 16),
+                                    make_number (((unsigned long) d) & 0xffff)));
+
       /* Loop reading blocks */
       /* (att3b compiler bug requires do a null comparison this way) */
       while (1)
@@ -536,12 +545,11 @@ file_name_completion (file, dirname, all_flag, ver_flag)
 
          len = NAMLEN (dp);
 
-         if (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
-           goto quit;
+         QUIT;
          if (! DIRENTRY_NONEMPTY (dp)
-             || len < XSTRING (encoded_file)->size
-             || 0 <= scmp (dp->d_name, XSTRING (encoded_file)->data,
-                           XSTRING (encoded_file)->size))
+             || len < SCHARS (encoded_file)
+             || 0 <= scmp (dp->d_name, SDATA (encoded_file),
+                           SCHARS (encoded_file)))
            continue;
 
           if (file_name_completion_stat (encoded_dir, dp, &st) < 0)
@@ -558,7 +566,7 @@ file_name_completion (file, dirname, all_flag, ver_flag)
                 actually in the way in a directory contains only one file.  */
              if (!passcount && TRIVIAL_DIRECTORY_ENTRY (dp->d_name))
                continue;
-             if (!passcount && len > XSTRING (encoded_file)->size)
+             if (!passcount && len > SCHARS (encoded_file))
                /* Ignore directories if they match an element of
                   completion-ignored-extensions which ends in a slash.  */
                for (tem = Vcompletion_ignored_extensions;
@@ -569,10 +577,13 @@ file_name_completion (file, dirname, all_flag, ver_flag)
                    elt = XCAR (tem);
                    if (!STRINGP (elt))
                      continue;
-                   elt_len = XSTRING (elt)->size - 1; /* -1 for trailing / */
+                   /* Need to encode ELT, since scmp compares unibyte
+                      strings only.  */
+                   elt = ENCODE_FILE (elt);
+                   elt_len = SCHARS (elt) - 1; /* -1 for trailing / */
                    if (elt_len <= 0)
                      continue;
-                   p1 = XSTRING (elt)->data;
+                   p1 = SDATA (elt);
                    if (p1[elt_len] != '/')
                      continue;
                    skip = len - elt_len;
@@ -588,19 +599,22 @@ file_name_completion (file, dirname, all_flag, ver_flag)
             {
              /* Compare extensions-to-be-ignored against end of this file name */
              /* if name is not an exact match against specified string */
-             if (!passcount && len > XSTRING (encoded_file)->size)
+             if (!passcount && len > SCHARS (encoded_file))
                /* and exit this for loop if a match is found */
                for (tem = Vcompletion_ignored_extensions;
                     CONSP (tem); tem = XCDR (tem))
                  {
                    elt = XCAR (tem);
                    if (!STRINGP (elt)) continue;
-                   skip = len - XSTRING (elt)->size;
+                   /* Need to encode ELT, since scmp compares unibyte
+                      strings only.  */
+                   elt = ENCODE_FILE (elt);
+                   skip = len - SCHARS (elt);
                    if (skip < 0) continue;
 
                    if (0 <= scmp (dp->d_name + skip,
-                                  XSTRING (elt)->data,
-                                  XSTRING (elt)->size))
+                                  SDATA (elt),
+                                  SCHARS (elt)))
                      continue;
                    break;
                  }
@@ -652,13 +666,13 @@ file_name_completion (file, dirname, all_flag, ver_flag)
              else
                {
                  bestmatch = name;
-                 bestmatchsize = XSTRING (name)->size;
+                 bestmatchsize = SCHARS (name);
                }
            }
          else
            {
              compare = min (bestmatchsize, len);
-             p1 = XSTRING (bestmatch)->data;
+             p1 = SDATA (bestmatch);
              p2 = (unsigned char *) dp->d_name;
              matchsize = scmp(p1, p2, compare);
              if (matchsize < 0)
@@ -672,8 +686,8 @@ file_name_completion (file, dirname, all_flag, ver_flag)
                  /* This tests that the current file is an exact match
                     but BESTMATCH is not (it is too long).  */
                  if ((matchsize == len
-                      && matchsize + !!directoryp 
-                         < XSTRING (bestmatch)->size)
+                      && matchsize + !!directoryp
+                         < SCHARS (bestmatch))
                      ||
                      /* If there is no exact match ignoring case,
                         prefer a match that does not change the case
@@ -685,10 +699,10 @@ file_name_completion (file, dirname, all_flag, ver_flag)
                         either both or neither are exact.  */
                      (((matchsize == len)
                        ==
-                       (matchsize + !!directoryp 
-                        == XSTRING (bestmatch)->size))
-                      && !bcmp (p2, XSTRING (encoded_file)->data, XSTRING (encoded_file)->size)
-                      && bcmp (p1, XSTRING (encoded_file)->data, XSTRING (encoded_file)->size)))
+                       (matchsize + !!directoryp
+                        == SCHARS (bestmatch)))
+                      && !bcmp (p2, SDATA (encoded_file), SCHARS (encoded_file))
+                      && bcmp (p1, SDATA (encoded_file), SCHARS (encoded_file))))
                    {
                      bestmatch = make_string (dp->d_name, len);
                      if (directoryp)
@@ -706,7 +720,8 @@ file_name_completion (file, dirname, all_flag, ver_flag)
              bestmatchsize = matchsize;
            }
        }
-      closedir (d);
+      /* This closes the directory.  */
+      bestmatch = unbind_to (inner_count, bestmatch);
     }
 
   UNGCPRO;
@@ -718,7 +733,7 @@ file_name_completion (file, dirname, all_flag, ver_flag)
        bestmatch = DECODE_FILE (bestmatch);
       return bestmatch;
     }
-  if (matchcount == 1 && bestmatchsize == XSTRING (file)->size)
+  if (matchcount == 1 && bestmatchsize == SCHARS (file))
     return Qt;
   bestmatch = Fsubstring (bestmatch, make_number (0),
                          make_number (bestmatchsize));
@@ -726,11 +741,34 @@ file_name_completion (file, dirname, all_flag, ver_flag)
      decode it from the coding system in use.  */
   bestmatch = DECODE_FILE (bestmatch);
   return bestmatch;
+}
+
+/* Compare exactly LEN chars of strings at S1 and S2,
+   ignoring case if appropriate.
+   Return -1 if strings match,
+   else number of chars that match at the beginning.  */
+
+static int
+scmp (s1, s2, len)
+     register unsigned char *s1, *s2;
+     int len;
+{
+  register int l = len;
 
- quit:
-  if (d) closedir (d);
-  Vquit_flag = Qnil;
-  return Fsignal (Qquit, Qnil);
+  if (completion_ignore_case)
+    {
+      while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
+       l--;
+    }
+  else
+    {
+      while (l && *s1++ == *s2++)
+       l--;
+    }
+  if (l == 0)
+    return -1;
+  else
+    return len - l;
 }
 
 static int
@@ -740,7 +778,7 @@ file_name_completion_stat (dirname, dp, st_addr)
      struct stat *st_addr;
 {
   int len = NAMLEN (dp);
-  int pos = XSTRING (dirname)->size;
+  int pos = SCHARS (dirname);
   int value;
   char *fullname = (char *) alloca (len + pos + 2);
 
@@ -757,7 +795,7 @@ file_name_completion_stat (dirname, dp, st_addr)
 #endif /* __DJGPP__ > 1 */
 #endif /* MSDOS */
 
-  bcopy (XSTRING (dirname)->data, fullname, pos);
+  bcopy (SDATA (dirname), fullname, pos);
 #ifndef VMS
   if (!IS_DIRECTORY_SEP (fullname[pos - 1]))
     fullname[pos++] = DIRECTORY_SEP;
@@ -787,18 +825,18 @@ file_name_completion_stat (dirname, dp, st_addr)
 #ifdef VMS
 
 DEFUN ("file-name-all-versions", Ffile_name_all_versions,
-  Sfile_name_all_versions, 2, 2, 0,
-  "Return a list of all versions of file name FILE in directory DIRECTORY.")
-  (file, directory)
+       Sfile_name_all_versions, 2, 2, 0,
+       doc: /* Return a list of all versions of file name FILE in directory DIRECTORY.  */)
+     (file, directory)
      Lisp_Object file, directory;
 {
   return file_name_completion (file, directory, 1, 1);
 }
 
 DEFUN ("file-version-limit", Ffile_version_limit, Sfile_version_limit, 1, 1, 0,
-  "Return the maximum number of versions allowed for FILE.\n\
-Returns nil if the file cannot be opened or if there is no version limit.")
-  (filename)
+       doc: /* Return the maximum number of versions allowed for FILE.
+Returns nil if the file cannot be opened or if there is no version limit.  */)
+     (filename)
      Lisp_Object filename;
 {
   Lisp_Object retval;
@@ -810,7 +848,7 @@ Returns nil if the file cannot be opened or if there is no version limit.")
   filename = Fexpand_file_name (filename, Qnil);
   fab      = cc$rms_fab;
   xabfhc   = cc$rms_xabfhc;
-  fab.fab$l_fna = XSTRING (filename)->data;
+  fab.fab$l_fna = SDATA (filename);
   fab.fab$b_fns = strlen (fab.fab$l_fna);
   fab.fab$l_xab = (char *) &xabfhc;
   status = sys$open (&fab, 0, 0);
@@ -834,29 +872,29 @@ make_time (time)
 }
 
 DEFUN ("file-attributes", Ffile_attributes, Sfile_attributes, 1, 1, 0,
-  "Return a list of attributes of file FILENAME.\n\
-Value is nil if specified file cannot be opened.\n\
-Otherwise, list elements are:\n\
- 0. t for directory, string (name linked to) for symbolic link, or nil.\n\
- 1. Number of links to file.\n\
- 2. File uid.\n\
- 3. File gid.\n\
- 4. Last access time, as a list of two integers.\n\
-  First integer has high-order 16 bits of time, second has low 16 bits.\n\
- 5. Last modification time, likewise.\n\
- 6. Last status change time, likewise.\n\
- 7. Size in bytes.\n\
-  This is a floating point number if the size is too large for an integer.\n\
- 8. File modes, as a string of ten letters or dashes as in ls -l.\n\
- 9. t iff file's gid would change if file were deleted and recreated.\n\
-10. inode number.  If inode number is larger than the Emacs integer,\n\
-  this is a cons cell containing two integers: first the high part,\n\
-  then the low 16 bits.\n\
-11. Device number.  If it is larger than the Emacs integer, this is\n\
-  a cons cell, similar to the inode number.\n\
-\n\
-If file does not exist, returns nil.")
-  (filename)
+       doc: /* Return a list of attributes of file FILENAME.
+Value is nil if specified file cannot be opened.
+Otherwise, list elements are:
+ 0. t for directory, string (name linked to) for symbolic link, or nil.
+ 1. Number of links to file.
+ 2. File uid.
+ 3. File gid.
+ 4. Last access time, as a list of two integers.
+  First integer has high-order 16 bits of time, second has low 16 bits.
+ 5. Last modification time, likewise.
+ 6. Last status change time, likewise.
+ 7. Size in bytes.
+  This is a floating point number if the size is too large for an integer.
+ 8. File modes, as a string of ten letters or dashes as in ls -l.
+ 9. t iff file's gid would change if file were deleted and recreated.
+10. inode number.  If inode number is larger than the Emacs integer,
+  this is a cons cell containing two integers: first the high part,
+  then the low 16 bits.
+11. Device number.  If it is larger than the Emacs integer, this is
+  a cons cell, similar to the inode number.
+
+If file does not exist, returns nil.  */)
+     (filename)
      Lisp_Object filename;
 {
   Lisp_Object values[12];
@@ -879,7 +917,7 @@ If file does not exist, returns nil.")
 
   encoded = ENCODE_FILE (filename);
 
-  if (lstat (XSTRING (encoded)->data, &s) < 0)
+  if (lstat (SDATA (encoded), &s) < 0)
     return Qnil;
 
   switch (s.st_mode & S_IFMT)
@@ -903,20 +941,24 @@ If file does not exist, returns nil.")
   /* If the size is out of range for an integer, return a float.  */
   if (XINT (values[7]) != s.st_size)
     values[7] = make_float ((double)s.st_size);
+  /* If the size is negative, and its type is long, convert it back to
+     positive.  */
+  if (s.st_size < 0 && sizeof (s.st_size) == sizeof (long))
+    values[7] = make_float ((double) ((unsigned long) s.st_size));
+
   filemodestring (&s, modes);
   values[8] = make_string (modes, 10);
 #if defined (BSD4_2) || defined (BSD4_3) /* file gid will be dir gid */
   dirname = Ffile_name_directory (filename);
   if (! NILP (dirname))
     encoded = ENCODE_FILE (dirname);
-  if (! NILP (dirname) && stat (XSTRING (encoded)->data, &sdir) == 0)
+  if (! NILP (dirname) && stat (SDATA (encoded), &sdir) == 0)
     values[9] = (sdir.st_gid != s.st_gid) ? Qt : Qnil;
   else                                 /* if we can't tell, assume worst */
     values[9] = Qt;
 #else                                  /* file gid will be egid */
   values[9] = (s.st_gid != getegid ()) ? Qt : Qnil;
 #endif /* BSD4_2 (or BSD4_3) */
-  /* Cast -1 to avoid warning if int is not as wide as VALBITS.  */
   if (FIXNUM_OVERFLOW_P (s.st_ino))
     /* To allow inode numbers larger than VALBITS, separate the bottom
        16 bits.  */
@@ -937,9 +979,9 @@ If file does not exist, returns nil.")
 }
 
 DEFUN ("file-attributes-lessp", Ffile_attributes_lessp, Sfile_attributes_lessp, 2, 2, 0,
-  "Return t if first arg file attributes list is less than second.\n\
-Comparison is in lexicographic order and case is significant.")
-  (f1, f2)
+       doc: /* Return t if first arg file attributes list is less than second.
+Comparison is in lexicographic order and case is significant.  */)
+     (f1, f2)
      Lisp_Object f1, f2;
 {
   return Fstring_lessp (Fcar (f1), Fcar (f2));
@@ -979,10 +1021,10 @@ syms_of_dired ()
 #endif /* VMS */
 
   DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions,
-    "*Completion ignores filenames ending in any string in this list.\n\
-Directories are ignored if they match any string in this list which\n\
-ends in a slash.\n\
-This variable does not affect lists of possible completions,\n\
-but does affect the commands that actually do completions.");
+              doc: /* *Completion ignores filenames ending in any string in this list.
+Directories are ignored if they match any string in this list which
+ends in a slash.
+This variable does not affect lists of possible completions,
+but does affect the commands that actually do completions.  */);
   Vcompletion_ignored_extensions = Qnil;
 }