[Cscope-cvs] CVS: cscope/doc cscope.1,1.13,1.14

[Petr S. <pe...@us...>]

Update of /cvsroot/cscope/cscope/doc
In directory usw-pr-cvs1:/tmp/cvs-serv22514/doc

Modified Files:
	cscope.1 
Log Message:
Jason Duell fix:

The default names for the inverse database files 
created with the -q option violate the regular cscope 
naming convention (they get called cscope.in.out and 
cscope.po.out, whereas if you call "cscope -f cscope", 
they get called cscope.out.in and cscope.out.po). This 
causes cscope to fail if you create the database 
without "-f cscope" but then try to load it with "-f 
cscope". Since the vim editor plugin for cscope always 
uses the -f flag, this makes it impossible to use the 
vim plugin unless you use the -f flag to create the 
database (and the editor freezes when you try to load 
the database). This is a needless hassle for new users. 

While the easiest fix for this problem would be to 
change to default names for the -q files to match the 
regular naming convention, this could break user setups 
that rely on the existing names. So this patch takes a 
different tack. Whenever "cscope.out" is loaded as the 
main database, both "cscope.po.out" and "cscope.out.po" 
are checked (ditto for cscope.in.out & cscope.out.in) 
before. The two combinations are checked in the 
appropriate order (i.e., "cscope.po.out" is checked 
first if the -f flag was not used, and "cscope.out.po" 
if it was). Only if neither file is present does the 
database load fail. 

The patch also contains a rewrite of the documentation 
for the -q option. I remember being confused by it 
when I first read the docs, and it now also contains 
information about the -f flag that is superfluous. 


Index: cscope.1
===================================================================
RCS file: /cvsroot/cscope/cscope/doc/cscope.1,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** cscope.1	2001/02/12 17:39:04	1.13
--- cscope.1	2001/05/30 19:31:23	1.14
***************
*** 123,130 ****
  .TP
  .B -q
! Build an inverted index for quick symbol searching. If you use
! this option with the -f option, you must use -f on every call
! to cscope, including when you build the cross-reference file,
! because it changes the names of the inverted index files.
  .TP
  .B -R
--- 123,131 ----
  .TP
  .B -q
! Enable fast symbol lookup via an inverted index. This option
! causes cscope to create 2 more files (default names
! ``cscope.in.out'' and ``cscope.po.out'') in addition to the normal
! database. This allows a faster symbol search algorithm that
! provides noticeably faster lookup performance for large projects.
  .TP
  .B -R