You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@tomcat.apache.org by André Warnier <aw...@ice-sa.com> on 2009/04/10 18:27:34 UTC

Contributing to Tomcat docs, long version

Hi.

This being the start of the Easter week-end, business being slow, having 
walked 3 times around the block and drunk 10 cups of coffee already, and 
having exhausted the mailing list, I decided to jump in and at least 
have a go at doing something else than filing complaints about Tomcat 
and Java on this list.
So I browsed to

http://tomcat.apache.org/connectors-doc/miscellaneous/doccontrib.html

and started to read and follow the instructions.

Mind you, I am not a Tomcat nor a Java expert, but I figure I can read 
and write, so I might occasionally find a spelling mistake in the 
on-line docs and thus contribute my bit.  Also, I met all these nice 
guys at the latest ApacheCON, and most of them had a badge with 
different colored stripes on it, and were thus much admired by the girls 
(of which there were only about three or so, mine included).
Anyway, I figured this might at least be a cheap way to get a discount 
next time.

To further set the stage : my laptop is not of the white slim flashy 
fruity variety which most of these guru guys sport, and it only runs 
Windows XP; but it's a nice working-horse kind of laptop, which has 
served me well for a couple of years now. It has 2 GB of RAM and still 
about 100 GB to spare on the disk. So why not, he ?

With a bit of apprehension, I downloaded and installed Ant.  That went 
well, except that when trying it out, it complained about not finding a 
"tools.jar".  But I quickly figured that one out.
Then I did the next thing in the page above (I already use SVN and 
Tortoise SVN, so that was a no-brainer).

The next thing is thus :

svn checkout http://svn.apache.org/repos/asf/tomcat/connectors/ 
tomcat-connectors

That started great, finding stuff as advertised and starting to create 
all these directories full of java and xml and c thingies.

After about 10 minutes of this, and seeing things scroll in the window 
like "Tomcat_4.1.2", I started wondering about how much stuff I was 
downloading.  A quick inspection showed me that we were at something 
like 700 MB and 50,000 files.
Wow, and this is only the Tomcat Connectors !  These guys are even more 
impressive than I thought !

10 minutes later, we were at 1.5 GB and about 100,000 directories, but 
it was still going nicely.  I was now seeing things that I never knew 
existed, such as Tomcat_native.x.y etc..

10 minutes later, we were at 2.2 Gb, and still going, but with some hiccups.

10 minutes later, a strange message appeared in the command window, 
telling me that my OS did not have enough resources available to execute 
the current service.
At the same time, my laptop pretty much froze.

There were still some faint desparate noises to be heard still from the 
disk drive, as if it was weakly and frantically trying to put away some 
stuff before giving up entirely.

After waiting for a while and trying to provide moral encouragement to 
my laptop, it finally got to the point where even CTRL-ALT-DEL did not 
elicit any reaction anymore.  I thus had to press the power button and 
switch my laptop off brutally.

This later cost me about an hour of disk checking, after which it seemed 
fortunately that everything was back in order again.  Seems these MS 
guys have learned some things over time after all.

Now I am left with an SVN/tomcat-connectors directory, containing some 
2.8 GB worth of files, apparently stopping at

C:\develop\06_SVN\tomcat-connectors\trunk\util\loader\org\apache\tomcat\util\loader

So I don't know if I should redo the whole svn checkout, or an update, 
or what ?

Oh, and another thing : having read the instructions beforehand, I 
wanted to contribute at least a note warning potential contributors of 
the above, and I wanted to do this in the approved way.
So I cliked on the link at the bottom of the page :

Bugzilla Bug Writing Guide

which leads to

http://issues.apache.org/bugzilla/bugwritinghelp.html

which leads to

Not Found

The requested URL /bugzilla/bugwritinghelp.html was not found on this 
server.
Apache/2.2.8 (Unix) mod_ssl/2.2.8 OpenSSL/0.9.8e Server at 
issues.apache.org Port 80


Are the Tomcat developers trying to tell us something there (like, don't) ?
:-)


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org


Re: Contributing to Tomcat docs, long version

Posted by David Smith <dn...@cornell.edu>.
André Warnier wrote:
> David Smith wrote:
>> Stab in the dark guess  -- you attempted to checkout trunk, all the tags
>> and all the branches.  This can be a really huge checkout in some
>> projects.  You might want to try to browse with your web browser just a
>> little deeper and choose what specific version you want to checkout.
>> Then take that url back to the svn command line.
>>
> Well, I did as indicated in the page on the website :
> svn checkout http://svn.apache.org/repos/asf/tomcat/connectors/
> > tomcat-connectors
> >
> I don't really know what I am doing by doing that.  From the volume
> and the list of files, I almost suspect that I have the whole of
> Tomcat, starting at Tomcat 3.0 or so...
>
> The person who wrote that page (I won't cite his name but I think his
> initials may be RJ) has this nice comment right after that line :
>
> You should now be watching all the downloads come in. Now that you
> have the sources on your machine the hard part is over.
>
> Quite..
> ;-)
>
A lot of svn repositories are split into:

trunk:  The current bleeding edge work, not released yet, pretty much
experimental
branches - different releases still being worked on.  More stable than
trunk, but may have new, untested features
tags - the frozen releases at specific versions.

If you look at http://svn.apache.org/repos/asf/tomcat/connectors/trunk/
for instance you'll see the bleeding edge/experimental/unreleased stuff.

If I'm reading the dir structure correctly, the latest release version
of jk would be at
http://svn.apache.org/repos/asf/tomcat/connectors/tags/jk1.2.x/JK_1_2_28/ .

Unfortunately, the doc you read regarding using svn to checkout the
connectors project appears to be out of date as the directory structure
there doesn't match the current state of the svn repository.

--David

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org


Re: Contributing to Tomcat docs, long version

Posted by Rainer Jung <ra...@kippdata.de>.
Hi André,

On 10.04.2009 20:15, André Warnier wrote:
> Rainer Jung wrote:
>> On 10.04.2009 19:54, André Warnier wrote:
>>> The person who wrote that page (I won't cite his name but I think his
>>> initials may be RJ) has this nice comment right after that line :
>>
>> See
>>
>> http://svn.eu.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/miscellaneous/doccontrib.xml
>>
>>
>> for a history of that page, or "simply" switch to your local
>> miscellaneous directory and do "svn log doccontrib.xml".
>>
>> There was a time the page was correct, well ...
>>
> Aha.
> That may explain why there are not many contributors to the docs.
> There might be 300 crashed laptops out there, and 300 former angry
> contributors-to-be.
> ;-)
> 
> So what do I do next, not being an Ant or SVN specialist ?
> 
> I have this directory on my laptop, under which are about 2.8 GB of
> Tomcat/connectors related stuff.
> I have .../SVN/tomcat-connectors at the top (2.8 GB), and
> below it I have C:\develop\06_SVN\tomcat-connectors\trunk (about 26 MB),
> but I doubt that the trunk part is complete,since that is where it crashed.
> Should I just go to /SVN/tomcat-connectors, delete everything under it,
> and then do a
> 
> svn checkout http://svn.apache.org/repos/asf/tomcat/connectors/trunk trunk
> 
> ?

At the moment all released versions of the last years are 1.2.x versions
and trunk is where we prepare for the next 1.2.x version.
So if you want to work on something around mod_jk, you will need trunk
and maybe one or two special versions, if you want to work on a specific
version of released code. Starting with trunk alone should be enough for
most things.

I plan to start a separate 1.3.x version line. At that point we will add
a branches/jk1.2.x and trunk will be used for 1.3.x. Repository changes
like this will not be announced on the users list. But all repository
changes are automatically mailed to the dev list.

I would start with a local directory tree

some_base_path/
   mod_jk/
      trunk/
      branches/
      tags/jk1.2.x/

(you can use some other name than "mod_jk", like e.g. "connectors" or
"tomcat-connectors").

And leave all of them except "trunk" empty until you actually need them.
To trunk you checkout

http://svn.apache.org/repos/asf/tomcat/connectors/trunk

e.g. by "cd" into the mod_jk directory and using the command you
proposed above.

You can always add some tagged version or a new branch whenever you
notice you need it.

HTH!

Regards,

Rainer

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org


Re: Contributing to Tomcat docs, long version

Posted by André Warnier <aw...@ice-sa.com>.
Rainer Jung wrote:
> On 10.04.2009 19:54, André Warnier wrote:
>> The person who wrote that page (I won't cite his name but I think his
>> initials may be RJ) has this nice comment right after that line :
> 
> See
> 
> http://svn.eu.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/miscellaneous/doccontrib.xml
> 
> for a history of that page, or "simply" switch to your local
> miscellaneous directory and do "svn log doccontrib.xml".
> 
> There was a time the page was correct, well ...
> 
Aha.
That may explain why there are not many contributors to the docs.
There might be 300 crashed laptops out there, and 300 former angry 
contributors-to-be.
;-)

So what do I do next, not being an Ant or SVN specialist ?

I have this directory on my laptop, under which are about 2.8 GB of 
Tomcat/connectors related stuff.
I have .../SVN/tomcat-connectors at the top (2.8 GB), and
below it I have C:\develop\06_SVN\tomcat-connectors\trunk (about 26 MB), 
but I doubt that the trunk part is complete,since that is where it crashed.
Should I just go to /SVN/tomcat-connectors, delete everything under it, 
and then do a

svn checkout http://svn.apache.org/repos/asf/tomcat/connectors/trunk trunk

?


I don't necessarily want to delete the rest, it might be a good source 
of inspiration some day.


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org


Re: Contributing to Tomcat docs, long version

Posted by Rainer Jung <ra...@kippdata.de>.
On 10.04.2009 19:54, André Warnier wrote:
> The person who wrote that page (I won't cite his name but I think his
> initials may be RJ) has this nice comment right after that line :

See

http://svn.eu.apache.org/viewvc/tomcat/connectors/trunk/jk/xdocs/miscellaneous/doccontrib.xml

for a history of that page, or "simply" switch to your local
miscellaneous directory and do "svn log doccontrib.xml".

There was a time the page was correct, well ...

Regards,

Rainer

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org


Re: Contributing to Tomcat docs, long version

Posted by André Warnier <aw...@ice-sa.com>.
David Smith wrote:
> Stab in the dark guess  -- you attempted to checkout trunk, all the tags
> and all the branches.  This can be a really huge checkout in some
> projects.  You might want to try to browse with your web browser just a
> little deeper and choose what specific version you want to checkout. 
> Then take that url back to the svn command line.
> 
Well, I did as indicated in the page on the website :
svn checkout http://svn.apache.org/repos/asf/tomcat/connectors/
 > tomcat-connectors
 >
I don't really know what I am doing by doing that.  From the volume and 
the list of files, I almost suspect that I have the whole of Tomcat, 
starting at Tomcat 3.0 or so...

The person who wrote that page (I won't cite his name but I think his 
initials may be RJ) has this nice comment right after that line :

You should now be watching all the downloads come in. Now that you have 
the sources on your machine the hard part is over.

Quite..
;-)

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org


Re: Contributing to Tomcat docs, long version

Posted by David Smith <dn...@cornell.edu>.
Stab in the dark guess  -- you attempted to checkout trunk, all the tags
and all the branches.  This can be a really huge checkout in some
projects.  You might want to try to browse with your web browser just a
little deeper and choose what specific version you want to checkout. 
Then take that url back to the svn command line.

--David

André Warnier wrote:
> Hi.
>
> This being the start of the Easter week-end, business being slow,
> having walked 3 times around the block and drunk 10 cups of coffee
> already, and having exhausted the mailing list, I decided to jump in
> and at least have a go at doing something else than filing complaints
> about Tomcat and Java on this list.
> So I browsed to
>
> http://tomcat.apache.org/connectors-doc/miscellaneous/doccontrib.html
>
> and started to read and follow the instructions.
>
> Mind you, I am not a Tomcat nor a Java expert, but I figure I can read
> and write, so I might occasionally find a spelling mistake in the
> on-line docs and thus contribute my bit.  Also, I met all these nice
> guys at the latest ApacheCON, and most of them had a badge with
> different colored stripes on it, and were thus much admired by the
> girls (of which there were only about three or so, mine included).
> Anyway, I figured this might at least be a cheap way to get a discount
> next time.
>
> To further set the stage : my laptop is not of the white slim flashy
> fruity variety which most of these guru guys sport, and it only runs
> Windows XP; but it's a nice working-horse kind of laptop, which has
> served me well for a couple of years now. It has 2 GB of RAM and still
> about 100 GB to spare on the disk. So why not, he ?
>
> With a bit of apprehension, I downloaded and installed Ant.  That went
> well, except that when trying it out, it complained about not finding
> a "tools.jar".  But I quickly figured that one out.
> Then I did the next thing in the page above (I already use SVN and
> Tortoise SVN, so that was a no-brainer).
>
> The next thing is thus :
>
> svn checkout http://svn.apache.org/repos/asf/tomcat/connectors/
> tomcat-connectors
>
> That started great, finding stuff as advertised and starting to create
> all these directories full of java and xml and c thingies.
>
> After about 10 minutes of this, and seeing things scroll in the window
> like "Tomcat_4.1.2", I started wondering about how much stuff I was
> downloading.  A quick inspection showed me that we were at something
> like 700 MB and 50,000 files.
> Wow, and this is only the Tomcat Connectors !  These guys are even
> more impressive than I thought !
>
> 10 minutes later, we were at 1.5 GB and about 100,000 directories, but
> it was still going nicely.  I was now seeing things that I never knew
> existed, such as Tomcat_native.x.y etc..
>
> 10 minutes later, we were at 2.2 Gb, and still going, but with some
> hiccups.
>
> 10 minutes later, a strange message appeared in the command window,
> telling me that my OS did not have enough resources available to
> execute the current service.
> At the same time, my laptop pretty much froze.
>
> There were still some faint desparate noises to be heard still from
> the disk drive, as if it was weakly and frantically trying to put away
> some stuff before giving up entirely.
>
> After waiting for a while and trying to provide moral encouragement to
> my laptop, it finally got to the point where even CTRL-ALT-DEL did not
> elicit any reaction anymore.  I thus had to press the power button and
> switch my laptop off brutally.
>
> This later cost me about an hour of disk checking, after which it
> seemed fortunately that everything was back in order again.  Seems
> these MS guys have learned some things over time after all.
>
> Now I am left with an SVN/tomcat-connectors directory, containing some
> 2.8 GB worth of files, apparently stopping at
>
> C:\develop\06_SVN\tomcat-connectors\trunk\util\loader\org\apache\tomcat\util\loader
>
>
> So I don't know if I should redo the whole svn checkout, or an update,
> or what ?
>
> Oh, and another thing : having read the instructions beforehand, I
> wanted to contribute at least a note warning potential contributors of
> the above, and I wanted to do this in the approved way.
> So I cliked on the link at the bottom of the page :
>
> Bugzilla Bug Writing Guide
>
> which leads to
>
> http://issues.apache.org/bugzilla/bugwritinghelp.html
>
> which leads to
>
> Not Found
>
> The requested URL /bugzilla/bugwritinghelp.html was not found on this
> server.
> Apache/2.2.8 (Unix) mod_ssl/2.2.8 OpenSSL/0.9.8e Server at
> issues.apache.org Port 80
>
>
> Are the Tomcat developers trying to tell us something there (like,
> don't) ?
> :-)
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: users-help@tomcat.apache.org
>


-- 
David Smith
Programmer/Analyst
College of Agriculture and Life Sciences
Cornell University
B32 Morrison Hall
Ithaca, NY 14853
Phone: (607) 255-4334


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org