Login | Register
My pages Projects Community openCollabNet

Discussions > commits > svn commit: r1577 - trunk: . fsvs/doc fsvs/src

fsvs
Discussion topic

Back to topic list

svn commit: r1577 - trunk: . fsvs/doc fsvs/src

Author pmarek
Full name P.Marek
Date 2008-04-01 22:24:33 PDT
Message Author: pmarek
Date: 2008-04-01 22:24:33-0700
New Revision: 1577

Modified:
   trunk/ (props changed)
   trunk/fsvs/doc/USAGE
   trunk/fsvs/doc/fsvs-options.5
   trunk/fsvs/doc/fsvs.1
   trunk/fsvs/src/doc.g-c

Log:
Updated the manual pages and included help


Modified: trunk/fsvs/doc/USAGE
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/doc/USA​GE?view=diff&rev​=1577&p1=trunk/f​svs/doc/USAGE&p2​=trunk/fsvs/doc/USAG​E&r1=1576&r2​=1577
====================​====================​====================​==================
--- trunk/fsvs/doc/USAGE (original)
+++ trunk/fsvs/doc/USAGE 2008-04-01 22:24:33-0700
@@ -242,6 +242,23 @@
    Also an environment variable FSVS_WARNINGS is used and parsed; it is
    simply a whitespace-separated list of option specifications.
 
+-u URLname[@revision] -- select URLs
+
+ Some commands' operations can be reduced to a subset of defined URLs;
+ the update command is the best example.
+
+ If you have more than a single URL in use for your working copy, and
+ update updates all entries from all URLs. By using this parameter you
+ can tell FSVS to update only a single URL.
+
+ The parameter can be used repeatedly; the value can have multiple URLs,
+ separated by whitespace or one of ",;".
+
+ fsvs up -u base_install,boot@32 -u gcc
+
+ This would get HEAD of base_install and gcc, and set the target
+ revision of the boot URL at 32.
+
 -o [name[=value]] -- other options
 
    This is used for setting some seldom used option, for which default can
@@ -735,6 +752,16 @@
    Per default it compares to HEAD, but you can choose another revision
    with the -r parameter.
 
+resolve
+
+ fsvs resolve PATH [PATH...]
+
+ When FSVS tries to update local files which have been changed, a
+ conflict might occur. (For various ways of handling these please see
+ the conflict option.)
+
+ This command lets you mark such conflicts as resolved.
+
 revert
 
  fsvs revert [-rRev] [-R] PATH [PATH...]
@@ -755,7 +782,7 @@
        copy) cannot be un-copied; they can only be reverted to their
        original (copied-from) data, or removed.
 
- See also HOWTO: Understand the entries statii.
+ See also HOWTO: Understand the entries' statii.
 
    If a directory is given on the command line all known entries in this
    directory are reverted to the old state; this behaviour can be modified
@@ -866,12 +893,13 @@
        changes, ie. the entries filesystem meta-data is unchanged.
      * A '+' is printed for files with a copy-from history; to see the URL
        of the copyfrom source, use -v twice.
+ * A 'x' signifies a conflict.
 
    Here's a table with the characters and their positions:
  * Without -v With -v
  * .... ......
  * NmC? NtpPC?
- * DP ! D !
+ * DPx! D x!
  * R + R +
  * d d
  * n n
@@ -921,18 +949,16 @@
 
 update
 
- fsvs update [-r rev] [working copy base]
+ ## invalid ## fsvs update [-r rev] [working copy base]
+ fsvs update [-u url@rev ...] [working copy base]
 
- This command does an update on all URLs for the current working copy.
+ This command does an update on all specified URLs for the current
+ working copy, or, if none is given via -u, all URLs.
 
    It first reads all changes in the repositories, overlays them (so that
    only the highest-priority entries are used), and fetches all necessary
    changes.
 
- Currently all URLS are update to the same revision (given per -r or
- HEAD by default) - although there'll be a way to update only some, and
- to a specific revision.
-
 urls
 
  fsvs urls URL [URLs...]
@@ -947,7 +973,7 @@
  fsvs urls http://svn/repos/ins​tallation/machine-1/​trunk
 
    For a format definition of the URLs please see the chapter Format of
- URLs .
+ URLs.
 
    Note:
           If there are already URLs defined, and use that command later
@@ -970,7 +996,7 @@
 
 Dumping the defined URLs
 
- To see which URLs are in use for the current WC, you can use dump .
+ To see which URLs are in use for the current WC, you can use dump.
 
    As an optional parameter you can give a format statement; p , n , r, t
    and u are substituted by the priority, name, current revision, target
@@ -982,4 +1008,5 @@
    http://svn/repos/ins​tallation/machine-1/​trunk local:10
    http://svn/repos/ins​tallation/common/tru​nk common:50
 
- The default format is "N:%n,P:%p,D:%t,%u\\n" .
+ The default format is "N:%n,P:%p,D:%t,%u\\n"; for a more readable
+ version you can use -v.

Modified: trunk/fsvs/doc/fsvs-options.5
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/doc/fsv​s-options.5?view=dif​f&rev=1577&p​1=trunk/fsvs/doc/fsv​s-options.5&p2=t​runk/fsvs/doc/fsvs-o​ptions.5&r1=1576​&r2=1577
====================​====================​====================​==================
--- trunk/fsvs/doc/fsvs-options.5 (original)
+++ trunk/fsvs/doc/fsvs-options.5 2008-04-01 22:24:33-0700
@@ -1,8 +1,49 @@
-.TH "Further options for FSVS." 1 "22 Feb 2008" "Version trunk:1473" "fsvs" \" -*- nroff -*-
+.TH "Further options for FSVS." 1 "1 Apr 2008" "Version trunk:2078" "fsvs" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
-Further options for FSVS. \- The priorities are
+Further options for FSVS. \- FSVS understands some other options, that modify its behaviour.
+.SH "Short list of options"
+.PP
+FSVS currently knows:
+.PD 0
+
+.IP "\(bu" 2
+\fCcolordiff\fP - \fBUsing colordiff\fP
+.IP "\(bu" 2
+\fCcommit_to\fP - \fBDestination URL for commit\fP
+.IP "\(bu" 2
+\fCconflict\fP - \fBHow to resolve conflicts on update\fP
+.IP "\(bu" 2
+\fCcopyfrom_exp\fP - \fBAvoiding expensive compares on \fBcopyfrom-detect\fP\fP
+.IP "\(bu" 2
+\fCdebug_output\fP - \fBDestination for debug output\fP
+.IP "\(bu" 2
+\fCdelay\fP - \fBWaiting for a time change after working copy operations\fP
+.IP "\(bu" 2
+\fCdiff_prg\fP, \fCdiff_opt\fP, \fCdiff_extra\fP - \fBOptions relating to the 'diff' action\fP
+.IP "\(bu" 2
+\fCdir_sort\fP - \fBDirectory sorting\fP
+.IP "\(bu" 2
+\fCempty_commit\fP - \fBDoing empty commits\fP
+.IP "\(bu" 2
+\fCfilter\fP - \fBFiltering entries\fP, but see \fB-f\fP.
+.IP "\(bu" 2
+\fClog_output\fP - \fB'fsvs log' output format\fP
+.IP "\(bu" 2
+\fCmerge_prg\fP, \fCmerge_opt\fP - \fBOptions regarding the 'merge' programm\fP
+.IP "\(bu" 2
+\fCpath\fP - \fBDisplaying paths\fP
+.IP "\(bu" 2
+\fCsoftroot\fP - \fBUsing an alternate root directory\fP
+.IP "\(bu" 2
+\fCstat_color\fP - \fBStatus output coloring\fP
+.IP "\(bu" 2
+\fCwarning\fP - \fBSetting warning behaviour\fP, but see \fB-W\fP.
+.PP
+.SH "Priorities for option setting"
+.PP
+The priorities are
 .PD 0
 
 .IP "\(bu" 2
@@ -27,11 +68,13 @@
 .RE
 .PP
 Furthermore there are 'intelligent' run-time dependent settings, like turning off colour output when the output is redirected. Their priority is just below the command line - so they can always be overridden if necessary.
+.SH "Examples"
 .PP
-Example for the commandline:
+Using the commandline:
 .PP
 .nf
      fsvs -o path=environment
+ fsvs -opath=environment
 
 .fi
 .PP
@@ -174,7 +217,7 @@
 The call is done as
 .PP
 .nf
- $ diff_prg $diff_opt $file1 --label '$label1' $file2 --label '$label2' diff_extra
+ $diff_prg $diff_opt $file1 --label '$label1' $file2 --label '$label2' diff_extra
 
 .fi
 .PP
@@ -351,6 +394,65 @@
 
 .fi
 .PP
+.SH "How to resolve conflicts on update"
+.PP
+If you start an update, but one of the entries that was changed in the repository is changed locally too, you get a conflict.
+.PP
+There are some ways to resolve a conflict:
+.PD 0
+
+.IP "\(bu" 2
+\fClocal\fP - Just take the local entry, ignore the repository.
+.PP
+
+.IP "\(bu" 2
+\fCremote\fP - Overwrite any local change with the remote version.
+.PP
+
+.IP "\(bu" 2
+\fCboth\fP - Keep the local modifications in the file renamed to \fC\fIfilename\fP.mine\fP, and save the repository version as \fC\fIfilename\fP​.r\fIXXX\fP\fP, ie. put the revision number after the filename.
+.PP
+These files will be seen as \fCNew\fP; the conflict must be solved manually, and the resolution made known to FSVS via \fBresolve\fP.
+.PP
+\fBNote:\fP
+.RS 4
+As there's no known \fIgood\fP version after this renaming, a zero byte file gets created.
+.br
+ Any \fBresolve\fP or \fBrevert\fP command would make that current, and the changes that are kept in \fC\fIfilename\fP.mine\fP would be lost!
+.br
+ You could only \fBrevert\fP to the last repository version, ie. the data of \fC\fIfilename\fP​.r\fIXXX\fP\fP.
+.RE
+.PP
+
+.IP "\(bu" 2
+\fCmerge\fP - Call the program \fCmerge\fP with the common ancestor, the local and the remote version.
+.PP
+If it is a clean merge, no further work is necessary; else you'll get the (partly) merged file, and the two other versions just like with the \fCboth\fP variant, and have to tell FSVS that the conflict is resolved by \fBresolve\fP.
+.PP
+.PP
+\fBNote:\fP
+.RS 4
+As in the subversion command line client \fCsvn\fP the auxiliary files are seen as new, although that might change in the future (so that they automatically get ignored).
+.RE
+.PP
+.SH "Options regarding the 'merge' programm"
+.PP
+Like with \fBdiff\fP, the \fCmerge\fP operation is not done internally in FSVS.
+.PP
+To have better control
+.IP "\(bu" 2
+\fCmerge_prg\fP: The executable name, default \fC'merge'\fP.
+.IP "\(bu" 2
+\fCmerge_opt\fP: The default options, default \fC'-A'\fP.
+.PP
+.PP
+The option \fC'-p'\fP is always used:
+.PP
+.nf
+ $merge_prg $merge_opt -p $file1 $common $file2
+
+.fi
+.PP
  
 .PP
 

Modified: trunk/fsvs/doc/fsvs.1
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/doc/fsv​s.1?view=diff&re​v=1577&p1=trunk/​fsvs/doc/fsvs.1&​p2=trunk/fsvs/doc/fs​vs.1&r1=1576​&r2=1577
====================​====================​====================​==================
--- trunk/fsvs/doc/fsvs.1 (original)
+++ trunk/fsvs/doc/fsvs.1 2008-04-01 22:24:33-0700
@@ -1,4 +1,4 @@
-.TH "Commands and command line parameters" 1 "22 Feb 2008" "Version trunk:1473" "fsvs" \" -*- nroff -*-
+.TH "Commands and command line parameters" 1 "1 Apr 2008" "Version trunk:2078" "fsvs" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -178,6 +178,19 @@
 .PP
 .PP
 Also an environment variable \fCFSVS_WARNINGS\fP is used and parsed; it is simply a whitespace-separated list of option specifications.
+.SS "-u URLname[@revision] -- select URLs"
+Some commands' operations can be reduced to a subset of defined URLs; the \fBupdate\fP command is the best example.
+.PP
+If you have more than a single URL in use for your working copy, and \fCupdate\fP updates \fBall\fP entries from \fBall\fP URLs. By using this parameter you can tell FSVS to update only a single URL.
+.PP
+The parameter can be used repeatedly; the value can have multiple URLs, separated by whitespace or one of \fC',;'\fP.
+.PP
+.PP
+.nf
+ fsvs up -u base_install,boot@32 -u gcc
+.fi
+.PP
+ This would get \fCHEAD\fP of \fCbase_install\fP and \fCgcc\fP, and set the target revision of the \fCboot\fP URL at 32.
 .SS "-o [name[=value]] -- other options"
 This is used for setting some seldom used option, for which default can be set in a configuration file (to be implemented, currently only command-line).
 .PP
@@ -664,6 +677,17 @@
 This command looks into the repository and tells you which files would get changed on an \fBupdate\fP - it's a dry-run for \fBupdate\fP .
 .PP
 Per default it compares to \fCHEAD\fP, but you can choose another revision with the \fC-r\fP parameter.
+.SH "resolve"
+.PP
+.PP
+.nf
+ fsvs resolve PATH [PATH...]
+.fi
+.PP
+.PP
+When FSVS tries to update local files which have been changed, a conflict might occur. (For various ways of handling these please see the \fBconflict\fP option.)
+.PP
+This command lets you mark such conflicts as resolved.
 .SH "revert"
 .PP
 .PP
@@ -685,7 +709,7 @@
  Please note that on implicitly copied entries (entries that are marked as copied because some parent directory is the base of a copy) \fBcannot\fP be un-copied; they can only be reverted to their original (copied-from) data, or removed.
 .PP
 .PP
-See also \fBHOWTO: Understand the entries statii\fP.
+See also \fBHOWTO: Understand the entries' statii\fP.
 .PP
 If a directory is given on the command line \fBall known entries in this directory\fP are reverted to the old state; this behaviour can be modified with \fB-R/-N\fP, or see below.
 .PP
@@ -761,6 +785,8 @@
  If \fC'P'\fP is shown for the non-verbose case, it means \fBonly\fP property changes, ie. the entries filesystem meta-data is unchanged.
 .IP "\(bu" 2
 A \fC'+'\fP is printed for files with a copy-from history; to see the URL of the copyfrom source, use \fC-v\fP twice.
+.IP "\(bu" 2
+A \fC'x'\fP signifies a conflict.
 .PP
 .PP
 Here's a table with the characters and their positions:
@@ -770,7 +796,7 @@
  * Without -v With -v
  * .... ......
  * NmC? NtpPC?
- * DP ! D !
+ * DPx! D x!
  * R + R +
  * d d
  * n n
@@ -813,15 +839,14 @@
 .PP
 .PP
 .nf
- fsvs update [-r rev] [working copy base]
+ ## invalid ## fsvs update [-r rev] [working copy base]
+ fsvs update [-u url@rev ...] [working copy base]
 .fi
 .PP
 .PP
-This command does an update on \fBall\fP URLs for the current working copy.
+This command does an update on all specified URLs for the current working copy, or, if none is given via \fB-u\fP, \fBall\fP URLs.
 .PP
 It first reads all changes in the repositories, overlays them (so that only the highest-priority entries are used), and fetches all necessary changes.
-.PP
-Currently all URLS are update to the same revision (given per \fC-r\fP or \fCHEAD\fP by default) - although there'll be a way to update only some, and to a specific revision.
 .SH "urls"
 .PP
 .PP
@@ -842,7 +867,7 @@
 .fi
 .PP
 .PP
-For a format definition of the URLs please see the chapter \fBFormat of URLs\fP .
+For a format definition of the URLs please see the chapter \fBFormat of URLs\fP.
 .PP
 \fBNote:\fP
 .RS 4
@@ -870,9 +895,9 @@
 .PP
 Empty lines are ignored.
 .SS "Dumping the defined URLs"
-To see which URLs are in use for the current WC, you can use \fCdump\fP .
+To see which URLs are in use for the current WC, you can use \fCdump\fP.
 .PP
-As an optional parameter you can give a format statement; \fCp\fP , \fCn\fP , \fCr\fP, \fCt\fP and \fCu\fP are substituted by the priority, name, current revision, target revision and URL. Note: That's not a real \fCprintf()-format\fP; only these and a few \\ sequences are recognized.
+As an optional parameter you can give a format statement; \fCp\fP , \fCn\fP , \fCr\fP, \fCt\fP and \fCu\fP are substituted by the priority, name, current revision, target revision and URL. Note: That's not a real \fCprintf()-format\fP; only these and a few \fC\\\fP sequences are recognized.
 .PP
 Example:
 .PP
@@ -884,6 +909,6 @@
 .fi
 .PP
 .PP
-The default format is \fC'N:%n,P:%p,D:%t,%u\\\\n'\fP .
+The default format is \fC'N:%n,P:%p,D:%t,%u\\\\n'\fP; for a more readable version you can use \fB-v\fP.
 .PP
 

Modified: trunk/fsvs/src/doc.g-c
Url: http://fsvs.tigris.o​rg/source/browse/fsv​s/trunk/fsvs/src/doc​.g-c?view=diff&r​ev=1577&p1=trunk​/fsvs/src/doc.g-c​&p2=trunk/fsvs/src/​doc.g-c&r1=1576​&r2=1577
====================​====================​====================​==================
--- trunk/fsvs/src/doc.g-c (original)
+++ trunk/fsvs/src/doc.g-c 2008-04-01 22:24:33-0700
@@ -1,12 +1,8 @@
 /* This file is generated, do not edit!
- * Last done on Sat Feb 23 17:20:49 2008
+ * Last done on Tue Apr 1 13:06:50 2008
  * */
 
 
-const char hlp_resolv[]=" fsvs resolve PATH [PATH...]\n"
- "\n"
- "\n";
-
 const char hlp_add[]=" fsvs add PATH [PATH...]\n"
   "\n"
   " With this command you can explicitly define entries to be versioned,\n"
@@ -425,6 +421,15 @@
   " with the -r parameter.\n"
   "\n";
 
+const char hlp_resolv[]=" fsvs resolve PATH [PATH...]\n"
+ "\n"
+ " When FSVS tries to update local files which have been changed, a\n"
+ " conflict might occur. (For various ways of handling these please see\n"
+ " the conflict option.)\n"
+ "\n"
+ " This command lets you mark such conflicts as resolved.\n"
+ "\n";
+
 const char hlp_revert[]=" fsvs revert [-rRev] [-R] PATH [PATH...]\n"
   "\n"
   " This command undoes local modifications:\n"
@@ -501,12 +506,13 @@
   " changes, ie. the entries filesystem meta-data is unchanged.\n"
   " * A '+' is printed for files with a copy-from history; to see the URL\n"
   " of the copyfrom source, use -v twice.\n"
+ " * A 'x' signifies a conflict.\n"
   "\n"
   " Here's a table with the characters and their positions:\n"
   " * Without -v With -v\n"
   " * .... ......\n"
   " * NmC? NtpPC?\n"
- " * DP ! D !\n"
+ " * DPx! D x!\n"
   " * R + R +\n"
   " * d d\n"
   " * n n\n"
@@ -554,17 +560,15 @@
   " needed.\n"
   "\n";
 
-const char hlp_update[]=" fsvs update [-r rev] [working copy base]\n"
+const char hlp_update[]=" ## invalid ## fsvs update [-r rev] [working copy base]\n"
+ " fsvs update [-u url@rev ...] [working copy base]\n"
   "\n"
- " This command does an update on all URLs for the current working copy.\n"
+ " This command does an update on all specified URLs for the current\n"
+ " working copy, or, if none is given via -u, all URLs.\n"
   "\n"
   " It first reads all changes in the repositories, overlays them (so that\n"
   " only the highest-priority entries are used), and fetches all necessary\n"
   " changes.\n"
- "\n"
- " Currently all URLS are update to the same revision (given per -r or\n"
- " HEAD by default) - although there'll be a way to update only some, and\n"
- " to a specific revision.\n"
   "\n";
 
 const char hlp_urls[]=" fsvs urls URL [URLs...]\n"
@@ -579,7 +583,7 @@
   " fsvs urls http://svn/repos/ins​tallation/machine-1/​trunk\n"
   "\n"
   " For a format definition of the URLs please see the chapter Format of\n"
- " URLs .\n"
+ " URLs.\n"
   "\n"
   " Note:\n"
   " If there are already URLs defined, and use that command later\n"

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

Messages

Show all messages in topic

svn commit: r1577 - trunk: . fsvs/doc fsvs/src pmarek P.Marek 2008-04-01 22:24:33 PDT
Messages per page: