doc

csync_reconcile.h

Go to the documentation of this file.
00001 /*
00002  * libcsync -- a library to sync a directory with another
00003  *
00004  * Copyright (c) 2008      by Andreas Schneider <mail@cynapses.org>
00005  *
00006  * This program is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU General Public License
00008  * as published by the Free Software Foundation; either version 2
00009  * of the License, or (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software Foundation,
00018  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
00019  */
00020 
00021 #ifndef _CSYNC_RECONCILE_H
00022 #define _CSYNC_RECONCILE_H
00023 
00024 /**
00025  * @file csync_reconcile.h
00026  *
00027  * @brief Reconciliation
00028  *
00029  * The most important component is the update detector, because the reconciler
00030  * depends on it. The correctness of reconciler is mandatory because it can
00031  * damage a filesystem. It decides which file:
00032  *
00033  *       - stays untouched
00034  *       - has a conflict
00035  *       - gets synchronized
00036  *       - or is deleted.
00037  *
00038  * @defgroup csyncReconcilationInternals csync reconciliation internals
00039  * @ingroup csyncInternalAPI
00040  *
00041  * @{
00042  */
00043 
00044 /**
00045  * @brief Reconcile the files.
00046  *
00047  * @param  ctx          The csync context to use.
00048  *
00049  * @return 0 on success, < 0 on error.
00050  *
00051  * @todo Add an argument to set the algorithm to use.
00052  */
00053 int csync_reconcile_updates(CSYNC *ctx);
00054 
00055 /**
00056  * }@
00057  */
00058 #endif /* _CSYNC_RECONCILE_H */
00059 
00060 /* vim: set ft=c.doxygen ts=8 sw=2 et cindent: */