lib/backup-rename.c

   1 /* Rename a file to a backup name, Emacs style.
   2
   3    Copyright 2017-2024 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 #include <config.h>
  19
  20 #include "backup-internal.h"
  21
  22 /* Relative to DIR_FD, rename the existing file FILE to a backup name,
  23    allocated with malloc, and return the backup name.  On failure
  24    return a null pointer, setting errno.  Do not call this function if
  25    backup_type == no_backups.  */
  26
  27 char *
  28 backup_file_rename (int dir_fd, char const *file, enum backup_type backup_type)
  29 {
  30   return backupfile_internal (dir_fd, file, backup_type, true);
  31 }