You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Phil Steitz <ph...@gmail.com> on 2005/12/03 22:24:41 UTC
Re: [all][POLL] what files to fixcrlf for windows distributions
I don't think it is feasible to patch the maven dist plugin or the
hand-rolled ant scripts to inspect .svn/props for each file and then
change line endings accordingly.
I also verified that distros created on Windows are in fact shipping
CRLF line endings on all files that have eol=native in their svn
props. A recent example is the 1.1 IO release. To me, this is a
problem, since it adds to the size of the distros and makes the
contents of the distro dependent on the OS used to build it.
I see three realistic options to fix this, none of which are ideal,
listed in order of how I view them. Other ideas - or statements that
this is a non-issue - welcome. I have already done the work for 2 and
will submit the patch if that is the preferred solution.
1. Change svn props to get rid of "eol=native" and specify "eol=crlf"
for .txt. IIUC the docs, lf is the default, so this should make all
sources default to lf. It does force Windows users to correctly set
line endings on patches, commits, etc. This is essentially going back
to the way things were in cvs.
2. Patch the maven dist plugin to put lf line endings on all of the
file types listed as recommended to have "eol=native" on the apache
svn pages and crlf on .txt files. I would make both properties
configurable in the plugin, with the default for the first being empty
and the second ".txt" The problem with this is getting all of the
extents fixed in the lf case.
3. Move to centralized release builds, running all release builds from
minotaur. Would have to work through the issues here.
Phil
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Phil Steitz <ph...@gmail.com>.
On 12/3/05, Martin van den Bemt <ml...@mvdb.net> wrote:
> Hi Stephen,
>
> Just add something like this in the maven.xml (the test is pretty useless probably..):
> <j:if test="${os != 'Linux'}">
> <ant:fixcrlf srcdir="." includes="${abatchfile}" eol="dos"/>
> </j:if>
>
> And of course you should add xmlns:ant="jelly:ant" to have the ant namespace available..
>
> Don't know from the top of my head which target to hijack when using the dist target (this was using a completely custom made dist target)
Which is what you need to do to make that work. You can't pregoal any
of the subgoals of dist to make this work, unfortunately. Requires a
patch to the dist plugin itself, which has been applied to svn head.
What is in svn head now does not allow the filter to be configured. I
will submit another patch that allows both crlf and lf filters to be
configured. We can choose to ignore the lf conversion if that is the
consensus, but apply crlf to .txt and other files for zips.
Phil
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Martin van den Bemt <ml...@mvdb.net>.
Hi Stephen,
Just add something like this in the maven.xml (the test is pretty useless probably..):
<j:if test="${os != 'Linux'}">
<ant:fixcrlf srcdir="." includes="${abatchfile}" eol="dos"/>
</j:if>
And of course you should add xmlns:ant="jelly:ant" to have the ant namespace available..
Don't know from the top of my head which target to hijack when using the dist target (this was using a completely custom made dist target)
Mvgr,
Martin
> Currently, I setup a custom ant script for each project I release, and
> never use maven for building. That way I can fix crlf for the root level
> text files in the zip and lf for the tar.
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Niall Pemberton <ni...@blueyonder.co.uk>.
----- Original Message -----
From: "Stephen Colebourne" <sc...@btopenworld.com>
Sent: Sunday, December 04, 2005 12:56 AM
> I was the one who initially raised this issue. The reason I raised it is
> that most _users_ run Windows. And the default text editor on Windows is
> Notepad which doesn't handle LF. Basically if I download a release and
> oopen the release notes, or project xml then I want CRLF, otherwise I
> have to close the file, find wordpad and reopen it.
I agree with Martin on this and IMO the simplest solution is to make the
release notes HTML - besides resolving this line ending issue, they also
look alot better than plain text in notepad or wordpad.
Niall
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Stephen Colebourne <sc...@btopenworld.com>.
Phil Steitz wrote:
> Thanks, Martin. I stand corrected then and will shut up about this.
> To close this out, I guess we are agreeing that we have no standard
> for line endings and will make no attempt to make them consistent. I
> did not know the Windows cvs client was also converting the files, so
> thought this was a "new" problem introduced by svn. Sorry for the
> noise.
I was the one who initially raised this issue. The reason I raised it is
that most _users_ run Windows. And the default text editor on Windows is
Notepad which doesn't handle LF. Basically if I download a release and
oopen the release notes, or project xml then I want CRLF, otherwise I
have to close the file, find wordpad and reopen it.
Now I understand the argument that our users are developers and shoud
know how to change file associations, and so on. But we here are
probably at the higher end of Java/programming knowledge. I want us to
cater for users who are more Junior. Also, Notepad is very quick to
start and open a small file, which is why some of use (ie. me) choose to
leave the txt to notepad association.
This discussion however, seems to have yielded no real solution to this.
I suspect that what is actually happening is that more commons release
managers now use Unix than previously, thus the problem is more apparant.
Currently, I setup a custom ant script for each project I release, and
never use maven for building. That way I can fix crlf for the root level
text files in the zip and lf for the tar.
However, as this discussion didn't reach agreement, I shall have to keep
quiet on this subject in future release votes.
Stephen
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Henri Yandell <fl...@gmail.com>.
Has everyone been following the bit on
http://www.apache.org/dev/version-control.html?
--------------------------------------
"Committers will need to properly configure their svn client. One
particular issue is OS-specific line-endings for text files. When you
add a new text file, especially when applying patches from Bugzilla,
first ensure that the line-endings are appropriate for *your* system,
then do ...
svn add test.txt
svn propset svn:eol-style native test.txt
Your svn client can be configured to do that automatically for some
common file types. Add the list to your ~/.subversion/config
[http://www.apache.org/dev/svn-eol-style.txt] file. However, you
should still pay attention to the messages from your svn client when
you do 'svn commit'. "
------------------------------
Just checking :)
Hen
On 12/3/05, Phil Steitz <ph...@gmail.com> wrote:
> Thanks, Martin. I stand corrected then and will shut up about this.
> To close this out, I guess we are agreeing that we have no standard
> for line endings and will make no attempt to make them consistent. I
> did not know the Windows cvs client was also converting the files, so
> thought this was a "new" problem introduced by svn. Sorry for the
> noise.
>
> I also agree (strongly) that we need to make releasing easier. Sorry
> if I this discussion seemed like negative progress.
>
> Phil
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Phil Steitz <ph...@gmail.com>.
Thanks, Martin. I stand corrected then and will shut up about this.
To close this out, I guess we are agreeing that we have no standard
for line endings and will make no attempt to make them consistent. I
did not know the Windows cvs client was also converting the files, so
thought this was a "new" problem introduced by svn. Sorry for the
noise.
I also agree (strongly) that we need to make releasing easier. Sorry
if I this discussion seemed like negative progress.
Phil
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [all][POLL] what files to fixcrlf for windows distributions
Posted by Martin Cooper <ma...@apache.org>.
On 12/3/05, Phil Steitz <ph...@gmail.com> wrote:
>
> I don't think it is feasible to patch the maven dist plugin or the
> hand-rolled ant scripts to inspect .svn/props for each file and then
> change line endings accordingly.
>
> I also verified that distros created on Windows are in fact shipping
> CRLF line endings on all files that have eol=native in their svn
> props. A recent example is the 1.1 IO release. To me, this is a
> problem, since it adds to the size of the distros and makes the
> contents of the distro dependent on the OS used to build it.
I really don't think this is an issue. It's been this way for _years_,
without any problems that I've been aware of. I see no reason to suddenly
declare it's an issue and go to all the lengths being discussed to "fix" it.
As for the size, given that the distributions are compressed, and text
compression algorithms are very good indeed, I seriously doubt that it's
going to make any significant difference.
I see three realistic options to fix this, none of which are ideal,
> listed in order of how I view them. Other ideas - or statements that
> this is a non-issue - welcome. I have already done the work for 2 and
> will submit the patch if that is the preferred solution.
>
> 1. Change svn props to get rid of "eol=native" and specify "eol=crlf"
> for .txt. IIUC the docs, lf is the default, so this should make all
> sources default to lf. It does force Windows users to correctly set
> line endings on patches, commits, etc. This is essentially going back
> to the way things were in cvs.
-1
First off, as I pointed out elsewhere, this is *not* going back to the way
things were with CVS. We had exactly the same issue when we were using CVS,
and nobody seemed to want to "fix" it then. In fact, we've had this same
situation since Commons was born. The Windows CVS command line client
defaults to CR-LF on checkout, as does WinCVS (which also has a checkbox you
need to explicitly check if you want Unix line ends).
The more serious issue, though, is that this can end up causing incorrect
line number reporting in diffs, exceptions, and in other cases, which is
going to make our job as component developers more painful than it already
is.
2. Patch the maven dist plugin to put lf line endings on all of the
> file types listed as recommended to have "eol=native" on the apache
> svn pages and crlf on .txt files. I would make both properties
> configurable in the plugin, with the default for the first being empty
> and the second ".txt" The problem with this is getting all of the
> extents fixed in the lf case.
>
> 3. Move to centralized release builds, running all release builds from
> minotaur. Would have to work through the issues here.
That would hurt the whole of Commons, IMO. It would force all of the Windows
developers to learn to do development - or at least building releases - in a
new environment, which will be more painful. This at a time where we really
need to make the release process as painless as possible, so that more
people are willing to take it on.
--
Martin Cooper
Phil
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>