Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 102219

Summary: [Doc] "Convert text files to use platform line ending" could be clearer or split into two options
Product: [Eclipse Project] Platform Reporter: Andrew Hayden <andrew.hayden>
Component: CVSAssignee: Tomasz Zarna <tomasz.zarna>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P5 CC: andrewbass
Version: 3.1Keywords: helpwanted
Target Milestone: 3.5 RC4   
Hardware: All   
OS: All   
Whiteboard:
Attachments:
Description Flags
Fix v01 none

Description Andrew Hayden CLA 2005-06-29 17:24:45 EDT
In Preferences -> Team -> CVS -> "Files and Folders" (tab):

The option "Convert text files to use platform line ending" could probably be
clearer in meaning.

In my experience if you leave this box checked, then not only do files that are
checked out have their line endings corrected, but *also* the CVS control files
(e.g. Entries, Root, etc) that are created will be created in the manner
appropriate to the platform.

When you uncheck this box, fortunately it works as I would *hope*, but certainly
not as I would *expect* from the description: it does in fact correctly seem to
make the CVS control files without the Windows line endings.

I think this option could probably be made clearer for everyone if the "example"
that is noted in it's help description were somehow tied in to its actual text.

Description from help:

"Use the option to convert the line endings of text files to the line ending
used by the platform. This option can be disabled if you are checking out
resources to a *nix drive that is mounted on a Windows machine."

What is really meant is something like, for example,  "Always treat local
filesystem like UNIX".  Not that it is a particularly great description, either.

What I was expecting when I checked this box was that the files I checked out
would have UNIX-compatible line endings, while the CVS control files would
retain their Windows-specific line endings.  I am glad this wasn't the case, but
it could definitely be clarified.

This is getting to be somewhat messy of a request.  I apologize for the length.
 Last part:

What is currently represented in this option should probably really be TWO options:
1. Select the line-endings for files checked out from the repository
2. Select the line-endings for the CVS control files that are created in the
proejct workspace

This allows maximum flexibility:

I want to check out files with UNIX line endings on a Windows system, and still
use cygwin/whatever to run CVS command-line tools;

I want to check out files with Windows line endings on a UNIX system (mapped
drive), and still use the command line to run CVS.

Hopefully I'm making this clear... sorry if that's not the case.  Regardless,
I'm pretty happy that the current option exists, so kudos to the dev team for
adding it to begin with (made my life a lot easier!)
Comment 1 Michael Valenta CLA 2005-06-30 09:00:28 EDT
This option was provided as a patch (so the dev team can't really take credit 
except for the fact that one of use committed it). I not convinced that we 
want two options here since I don't believe there would ever be a case where 
you want the files to use one line-ending and the meta-files to use another 
(if you know of a case, feel free to describe it). I think the right answer is 
to make it clear that the option applies to both the files and the control 
files.
Comment 2 Andrew Hayden CLA 2005-08-05 19:31:29 EDT
After more consideration, I agree with Michael.  The proper way is probably just
to make it clearer.  Two options would be far too confusing and isn't worthwhile.
Comment 3 Tomasz Zarna CLA 2009-06-03 09:44:43 EDT
Created attachment 138152 [details]
Fix v01
Comment 4 Tomasz Zarna CLA 2009-06-03 09:46:26 EDT
Released to HEAD, available in builds >I20090602-2000.