af_alg: Improve comments.
[gnulib.git] / lib / backup-rename.c
blob292b7f2ff92a609a3909ef97f6cfd7178dd8548e
1 /* Rename a file to a backup name, Emacs style.
3 Copyright 2017-2018 Free Software Foundation, Inc.
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.
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.
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/>. */
18 #include <config.h>
20 #include "backup-internal.h"
22 /* Rename the existing file FILE to a backup name, allocated with
23 malloc, and return the backup name. On failure return a null
24 pointer, setting errno. Do not call this function if backup_type
25 == no_backups. */
27 char *
28 backup_file_rename (char const *file, enum backup_type backup_type)
30 return backupfile_internal (file, backup_type, true);