Login | Register
My pages Projects Community openCollabNet

Discussions > commits > svn commit: r1756 - trunk/fsvs/src: . dox

fsvs
Discussion topic

Back to topic list

svn commit: r1756 - trunk/fsvs/src: . dox

Author pmarek
Full name P.Marek
Date 2008-06-13 07:43:22 PDT
Message Author: pmarek
Date: 2008-06-13 07:43:22-0700
New Revision: 1756

Modified:
   trunk/fsvs/src/actions.h
   trunk/fsvs/src/dox/options.dox
   trunk/fsvs/src/waa.h

Log:
Some fixes for the doxygen comments.

Modified: trunk/fsvs/src/actions.h
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/src/act​ions.h?view=diff​&rev=1756&p1=tru​nk/fsvs/src/actions.​h&p2=trunk/fsvs/​src/actions.h&r1​=1755&r2=1756
====================​====================​====================​==================
--- trunk/fsvs/src/actions.h (original)
+++ trunk/fsvs/src/actions.h 2008-06-13 07:43:22-0700
@@ -15,20 +15,20 @@
 /** \file
  * Action handling header file. */
 
-/** \name callbacks Action callbacks. */
+/** \anchor callbacks \name callbacks Action callbacks. */
 /** @{ */
 /** Callback that gets called for each entry.
  *
  * Entries get read from the entry list in global [device, inode] order; in
- * the normal action callback (\ref action_t::local_callback and \ref
- * action_t::repos_feedback) the parent entries are handled \b after child
+ * the normal action callback (\ref actionlist_t::local_callback and \ref
+ * actionlist_t::repos_feedback) the parent entries are handled \b after child
  * entries (but the parent \c struct \ref estat "estats" exist, of course),
  * so that the list of children is correct.
  *
  * As in the entry list file (\ref dir) there is a callback \ref
- * action_t::early_entry that's done \b before the child entries;
+ * actionlist_t::early_entry that's done \b before the child entries;
  * Clearing \ref estat::do_this_entry and \ref estat::do_tree in this
- * callback will skip calling \ref action_t::local_callback for this and
+ * callback will skip calling \ref actionlist_t::local_callback for this and
  * the child entries (see \ref ops__set_to_handle_bits()).
  *
  * See also \ref waa__update_tree.

Modified: trunk/fsvs/src/dox/options.dox
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/src/dox​/options.dox?view=di​ff&rev=1756&​p1=trunk/fsvs/src/do​x/options.dox&p2​=trunk/fsvs/src/dox/​options.dox&r1=1​755&r2=1756
====================​====================​====================​==================
--- trunk/fsvs/src/dox/options.dox (original)
+++ trunk/fsvs/src/dox/options.dox 2008-06-13 07:43:22-0700
@@ -14,7 +14,7 @@
 <LI>\c colordiff - \ref o_colordiff
 <LI>\c commit_to - \ref o_commit_to
 <LI>\c conflict - \ref o_conflict
-<LI>\c conf - \ref o_conf. </UL>
+<LI>\c conf - \ref o_conf.
 <LI>\c copyfrom_exp - \ref o_copyfrom_exp
 <LI>\c debug_output - \ref o_debug_output
 <LI>\c delay - \ref o_delay
@@ -30,7 +30,8 @@
 <LI>\c stat_color - \ref o_status_color
 <LI>\c stop_on_change - \ref o_stop_change
 <LI>\c warning - \ref o_warnings, but see \ref glob_opt_warnings "-W".
-<LI>\c waa - \ref o_waa. </UL>
+<LI>\c waa - \ref o_waa.
+</UL>
 
 
 \section o__prio Priorities for option setting
@@ -237,7 +238,7 @@
 \section o_softroot Using an alternate root directory
 
 This is a path that is prepended to \c $FSVS_WAA and \c $FSVS_CONF
-(or their default values, see \ref envs), if they do not already
+(or their default values, see \ref waa_files), if they do not already
 start with it, and it is cut off for the directory-name MD5 calculation.
 
 When is that needed? Imagine that you've booted from some Live-CD like
@@ -431,7 +432,7 @@
 anything was changed.
 
 For this use the \c stop_on_change option, possibly combined with
-\ref o_filter:
+\ref o_filter :
 \code
     fsvs -o stop_change=yes st /etc
     fsvs -o stop_change=yes -o filter=text status /etc/init.d

Modified: trunk/fsvs/src/waa.h
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/src/waa​.h?view=diff&rev​=1756&p1=trunk/f​svs/src/waa.h&p2​=trunk/fsvs/src/waa.​h&r1=1755&r2​=1756
====================​====================​====================​==================
--- trunk/fsvs/src/waa.h (original)
+++ trunk/fsvs/src/waa.h 2008-06-13 07:43:22-0700
@@ -58,11 +58,10 @@
  * about the system it is running on.
  *
  * Two file trees are used:
- * - \c /var/spool/fsvs (if not overridden by \ref WAA__PATH_ENV
- * "$FSVS_WAA").
+ * - \c /var/spool/fsvs (if not overridden by \ref o_waa "$FSVS_WAA").
  * The WAA stores volatile data that should not be backed up; the files
  * have only lower-case letters.
- * - \c /etc/fsvs (or \ref CONF__PATH_ENV "$FSVS_CONF")
+ * - \c /etc/fsvs (or \ref o_conf "$FSVS_CONF")
  * This is used to store configuration data, eg. for the working copies.
  * The names of files stored here have the first letter in upper-case.
  * Having this data backed-up (eg. along with the rest of the filesystem)

« Previous message in topic | 1 of 1 | Next message in topic »

Messages

Show all messages in topic

svn commit: r1756 - trunk/fsvs/src: . dox pmarek P.Marek 2008-06-13 07:43:22 PDT
Messages per page: