doc
csync_reconcile.h
Go to the documentation of this file.
1 /*
2  * libcsync -- a library to sync a directory with another
3  *
4  * Copyright (c) 2008-2013 by Andreas Schneider <asn@cryptomilk.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #ifndef _CSYNC_RECONCILE_H
22 #define _CSYNC_RECONCILE_H
23 
24 /**
25  * @file csync_reconcile.h
26  *
27  * @brief Reconciliation
28  *
29  * The most important component is the update detector, because the reconciler
30  * depends on it. The correctness of reconciler is mandatory because it can
31  * damage a filesystem. It decides which file:
32  *
33  * - stays untouched
34  * - has a conflict
35  * - gets synchronized
36  * - or is deleted.
37  *
38  * @defgroup csyncReconcilationInternals csync reconciliation internals
39  * @ingroup csyncInternalAPI
40  *
41  * @{
42  */
43 
44 /**
45  * @brief Reconcile the files.
46  *
47  * @param ctx The csync context to use.
48  *
49  * @return 0 on success, < 0 on error.
50  *
51  * @todo Add an argument to set the algorithm to use.
52  */
54 
55 /**
56  * }@
57  */
58 #endif /* _CSYNC_RECONCILE_H */
59 
60 /* vim: set ft=c.doxygen ts=8 sw=2 et cindent: */
csync public structure
Definition: csync_private.h:89
int csync_reconcile_updates(CSYNC *ctx)
Reconcile the files.