You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@tomcat.apache.org by Mark Thomas <ma...@apache.org> on 2010/09/17 13:27:55 UTC
[ANN] CI for Tomcat 6 and 7 docs now available
Thanks to the infrastructure team (specifically Gavin in this case) we
now have CI builds of the Tomcat 6 & 7 docs that will update with every
commit.
They can be found here:
http://ci.apache.org/projects/tomcat/tomcat6/docs/
http://ci.apache.org/projects/tomcat/tomcat7/docs/
This got me thinking. I recall at least one (André?) offer to help
improve the documentation. This should make that a little easier,
particularly for folks here to review the latest changes.
If you do get involved then the process would be something along the
lines of:
(one time tasks)
- install svn
- install ant
- checkout source
- build Tomcat
(per change task)
- change docs
- build Tomcat to test changes
- use svn to create a patch
- create a Bugzilla entry for the patch
- committer reviews and applies the pacth / suggests changes
Usually after a series of good patches the committers will get fed up
with applying your patches for you and will make you a committer so you
can do you own commits.
If you would like to get involved then I am happy to help get you set
up. Just ping an e-mail to the users list. I'd like to keep it on the
users list so the info is there to help anyone else who wants to get
started with building Tomcat.
Mark
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Ian Darwin <ia...@darwinsys.com>.
> Dumb question: what is a "CI build"?
Continuous Integration.
See http://www.martinfowler.com/articles/continuousIntegration.html
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Christopher Schultz <ch...@christopherschultz.net>.
Mark,
On 9/17/2010 7:27 AM, Mark Thomas wrote:
> Thanks to the infrastructure team (specifically Gavin in this case) we
> now have CI builds of the Tomcat 6 & 7 docs that will update with every
> commit.
Dumb question: what is a "CI build"?
-chris
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Mark Thomas <ma...@apache.org>.
On 17/09/2010 12:52, Wesley Acheson wrote:
> On Fri, Sep 17, 2010 at 1:27 PM, Mark Thomas <ma...@apache.org> wrote:
>
>> This got me thinking. I recall at least one (André?) offer to help
>> improve the documentation. This should make that a little easier,
>> particularly for folks here to review the latest changes.
>
> I offered to do a generic correction on the building instructions of
> tc7 but haven't found time yet.
>
>> If you do get involved then the process would be something along the
>> lines of:
>> (one time tasks)
>> - install svn
>> - install ant
>> - checkout source
>> - build Tomcat
>> (per change task)
>
> So your saying apply each patch individually and rebuild after each?
> Or am I misreading? and then put the documentation for that patch in.
What I was trying to say was that for each 'change' (could be big or
small) the person working on that change needs to:
- ensure Tomcat still builds with the changes applied (if you mess up
the xml, the build will break)
- provide a patch (could be 1 line, could be 1000 lines)
- add the patch to Bugzilla
- etc
Mark
>
>> - change docs
>> - build Tomcat to test changes
>> - use svn to create a patch
>> - create a Bugzilla entry for the patch
>> - committer reviews and applies the pacth / suggests changes
>>
>> Usually after a series of good patches the committers will get fed up
>> with applying your patches for you and will make you a committer so you
>> can do you own commits.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: users-help@tomcat.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Wesley Acheson <we...@gmail.com>.
On Fri, Sep 17, 2010 at 1:27 PM, Mark Thomas <ma...@apache.org> wrote:
> This got me thinking. I recall at least one (André?) offer to help
> improve the documentation. This should make that a little easier,
> particularly for folks here to review the latest changes.
I offered to do a generic correction on the building instructions of
tc7 but haven't found time yet.
> If you do get involved then the process would be something along the
> lines of:
> (one time tasks)
> - install svn
> - install ant
> - checkout source
> - build Tomcat
> (per change task)
So your saying apply each patch individually and rebuild after each?
Or am I misreading? and then put the documentation for that patch in.
> - change docs
> - build Tomcat to test changes
> - use svn to create a patch
> - create a Bugzilla entry for the patch
> - committer reviews and applies the pacth / suggests changes
>
> Usually after a series of good patches the committers will get fed up
> with applying your patches for you and will make you a committer so you
> can do you own commits.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Pid <pi...@pidster.com>.
On 17/09/2010 12:27, Mark Thomas wrote:
> Thanks to the infrastructure team (specifically Gavin in this case) we
> now have CI builds of the Tomcat 6 & 7 docs that will update with every
> commit.
>
> They can be found here:
> http://ci.apache.org/projects/tomcat/tomcat6/docs/
> http://ci.apache.org/projects/tomcat/tomcat7/docs/
Nice.
> This got me thinking. I recall at least one (André?) offer to help
> improve the documentation. This should make that a little easier,
> particularly for folks here to review the latest changes.
FYI: I've got a partially working model of the docs in a new
layout/design, (to match the incomplete, but proposed Tomcat 7.0
ROOT/index.html) but it still needs work in IE and testing properly,
which I haven't had time for recently.
p
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by David Fisher <df...@jmlafferty.com>.
>>> Mark Thomas wrote:
>>> ...
>>>>>> If you want to start down this path and see how it goes, I am happy to
>>>>>> talk you through step by step.
>>>>>>
>>>>> I may (hem, probably will) need that at some point.
>>>>> But let me try following the basic steps you outlined, first.
>>>>>
>>> quoting :
>>>
>>> If you do get involved then the process would be something along the
>>> lines of:
>>> (one time tasks)
>>> - added : install or update Java JDK .. done
>>> - install svn .. done
>>> - install ant .. done
>>> - checkout source .. (done too, thanks Wesley)
> ( The current url for tc7 is http://svn.apache.org/repos/asf/tomcat/trunk)
>>> - build Tomcat .. done
>
>>> (per change task)
>>> - change docs
>
> Where ? I do not see any docs here.
http://svn.apache.org/repos/asf/tomcat/trunk/webapps/docs/
>>> - build Tomcat to test changes
ant build-docs
http://svn.apache.org/repos/asf/tomcat/trunk/build.xml
style="webapps/docs/tomcat-docs.xsl"
Good luck. Looks better than the ancient Forrest xslt we use for POI. :-)
Regards,
Dave
>>> - use svn to create a patch
>>> - create a Bugzilla entry for the patch
>>> - committer reviews and applies the pacth / suggests changes
>>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: users-help@tomcat.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by André Warnier <aw...@ice-sa.com>.
Wesley Acheson wrote:
> On Fri, Sep 17, 2010 at 11:25 PM, André Warnier <aw...@ice-sa.com> wrote:
>> Mark Thomas wrote:
>> ...
>>>>> If you want to start down this path and see how it goes, I am happy to
>>>>> talk you through step by step.
>>>>>
>>>> I may (hem, probably will) need that at some point.
>>>> But let me try following the basic steps you outlined, first.
>>>>
>> quoting :
>>
>> If you do get involved then the process would be something along the
>> lines of:
>> (one time tasks)
>> - added : install or update Java JDK .. done
>> - install svn .. done
>> - install ant .. done
>> - checkout source .. (done too, thanks Wesley)
( The current url for tc7 is http://svn.apache.org/repos/asf/tomcat/trunk)
>> - build Tomcat .. done
>> (per change task)
>> - change docs
Where ? I do not see any docs here.
>> - build Tomcat to test changes
>> - use svn to create a patch
>> - create a Bugzilla entry for the patch
>> - committer reviews and applies the pacth / suggests changes
>>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Wesley Acheson <we...@gmail.com>.
On Fri, Sep 17, 2010 at 11:25 PM, André Warnier <aw...@ice-sa.com> wrote:
> Mark Thomas wrote:
> ...
>>
>>>> If you want to start down this path and see how it goes, I am happy to
>>>> talk you through step by step.
>>>>
>>> I may (hem, probably will) need that at some point.
>>> But let me try following the basic steps you outlined, first.
>>>
> quoting :
>
> If you do get involved then the process would be something along the
> lines of:
> (one time tasks)
> - added : install or update Java JDK .. done
> - install svn .. done
> - install ant .. done
> - checkout source
>
> Ok, I'm here. I have a top directory c:\projects, under which I have already
> a couple of (unrelated) SVN repositories. Assuming I'd like first to have a
> look at the latest Tomcat 7.0 release, what do I do next ?
> I right-clicked on the directory, chose "Tortoise SVN", then "Create
> repository here", and it is asking me for a URL. I do not want to download
> the whole ASF repository, and not even all Tomcat versions, so what do I
> enter ?
>
The current url for tc7 is http://svn.apache.org/repos/asf/tomcat/trunk
>
> - build Tomcat
> (per change task)
> - change docs
> - build Tomcat to test changes
> - use svn to create a patch
> - create a Bugzilla entry for the patch
> - committer reviews and applies the pacth / suggests changes
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: users-help@tomcat.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by André Warnier <aw...@ice-sa.com>.
Mark Thomas wrote:
...
>
>>> If you want to start down this path and see how it goes, I am happy to
>>> talk you through step by step.
>>>
>> I may (hem, probably will) need that at some point.
>> But let me try following the basic steps you outlined, first.
>>
quoting :
If you do get involved then the process would be something along the
lines of:
(one time tasks)
- added : install or update Java JDK .. done
- install svn .. done
- install ant .. done
- checkout source
Ok, I'm here. I have a top directory c:\projects, under which I have already a couple of
(unrelated) SVN repositories. Assuming I'd like first to have a look at the latest Tomcat
7.0 release, what do I do next ?
I right-clicked on the directory, chose "Tortoise SVN", then "Create repository here", and
it is asking me for a URL. I do not want to download the whole ASF repository, and not
even all Tomcat versions, so what do I enter ?
- build Tomcat
(per change task)
- change docs
- build Tomcat to test changes
- use svn to create a patch
- create a Bugzilla entry for the patch
- committer reviews and applies the pacth / suggests changes
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Mark Thomas <ma...@apache.org>.
On 17/09/2010 16:24, André Warnier wrote:
> as answer to Mark and Ongjen..
>
> Mark Thomas wrote:
> ...
>
>> It is going to get complicated if you don't have a JDK to hand.
>
> The Java JDK is no problem, I have. My fear was that I would need some
> C compiler, maybe for native dll's or so.
> My laptop is WinXP, with JDK and Tortoise SVN, and I'll see about Ant. I
> haven't got the committer-grade white shiny thing with the apple on it
> yet. If you tell me it's easier to do this from a Linux system however,
> I've got that too (Debian), just less portable.
I do 99% of my development on 64-bit Windows XP so you should be fine
with that. The native bits (mod_jk, APR/native) are built separately and
the binaries / src tarballs downloaded from the ASF archives as required.
Just make sure you have Ant 1.8 or later. Just get the latest and you'll
be fine.
>> If you want to start down this path and see how it goes, I am happy to
>> talk you through step by step.
>>
> I may (hem, probably will) need that at some point.
> But let me try following the basic steps you outlined, first.
>
> I went through this once with Rainer for some mod_jk documentation, so I
> should be able to get past item 1.
np
Mark
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by André Warnier <aw...@ice-sa.com>.
as answer to Mark and Ongjen..
Mark Thomas wrote:
...
> It is going to get complicated if you don't have a JDK to hand.
The Java JDK is no problem, I have. My fear was that I would need some C compiler, maybe
for native dll's or so.
My laptop is WinXP, with JDK and Tortoise SVN, and I'll see about Ant. I haven't got the
committer-grade white shiny thing with the apple on it yet. If you tell me it's easier to
do this from a Linux system however, I've got that too (Debian), just less portable.
...
>
> If you want to start down this path and see how it goes, I am happy to
> talk you through step by step.
>
I may (hem, probably will) need that at some point.
But let me try following the basic steps you outlined, first.
I went through this once with Rainer for some mod_jk documentation, so I should be able to
get past item 1.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Mark Thomas <ma...@apache.org>.
On 17/09/2010 13:56, André Warnier wrote:
> Mark Thomas wrote:
>> If you do get involved then the process would be something along the
>> lines of:
>> (one time tasks)
>> - install svn
>> - install ant
>> - checkout source
>> - build Tomcat
>> (per change task)
>
> Sorry if I ask, but I am really unfamiliar with these things.
> Does this involve any actual compiling of code ?
It is actually easier to do a full build of both the code and the docs
since that is how the build is configured by default. You then also get
a ready to run Tomcat instance with the updated docs deployed.
> I mean, if the only thing that is changed is some documentation page, it
> won't I guess.
The build is reasonably incremental. A doc change shouldn't trigger a
rebuild of any code. However, since you would be working with trunk,
you'd need to do an "svn up" to ensure you had the latest versions. That
might change code which would trigger a rebuild of that class.
> But would the build break just because there is no
> compiler available ?
It is going to get complicated if you don't have a JDK to hand.
> I guess I've just lost all my guru points here.
Not at all. A key feature of being a guru is knowing what you *don't* know.
If you want to start down this path and see how it goes, I am happy to
talk you through step by step.
Mark
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by Ognjen Blagojevic <og...@gmail.com>.
On 17.9.2010 14:56, André Warnier wrote:
> Sorry if I ask, but I am really unfamiliar with these things.
> Does this involve any actual compiling of code ?
> I mean, if the only thing that is changed is some documentation page, it
> won't I guess. But would the build break just because there is no
> compiler available ?
It seems to me that Tomcat keeps documentation in XML files in
webapps/docs folder. In order to generate HTML files from XML, it needs
to do XSL transformation, which is configured inside Ant, and Ant won't
work without Java.
Bottom line: You need to install both Java and Ant.
Regards,
Ognjen
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org
Re: [ANN] CI for Tomcat 6 and 7 docs now available
Posted by André Warnier <aw...@ice-sa.com>.
Mark Thomas wrote:
> Thanks to the infrastructure team (specifically Gavin in this case) we
> now have CI builds of the Tomcat 6 & 7 docs that will update with every
> commit.
>
> They can be found here:
> http://ci.apache.org/projects/tomcat/tomcat6/docs/
> http://ci.apache.org/projects/tomcat/tomcat7/docs/
>
> This got me thinking. I recall at least one (André?) offer to help
> improve the documentation.
Yes, in one of my weaker moments. sigh.
This should make that a little easier,
> particularly for folks here to review the latest changes.
>
> If you do get involved then the process would be something along the
> lines of:
> (one time tasks)
> - install svn
> - install ant
> - checkout source
> - build Tomcat
> (per change task)
Sorry if I ask, but I am really unfamiliar with these things.
Does this involve any actual compiling of code ?
I mean, if the only thing that is changed is some documentation page, it won't I guess.
But would the build break just because there is no compiler available ?
I guess I've just lost all my guru points here.
> - change docs
> - build Tomcat to test changes
> - use svn to create a patch
> - create a Bugzilla entry for the patch
> - committer reviews and applies the pacth / suggests changes
>
> Usually after a series of good patches the committers will get fed up
> with applying your patches for you and will make you a committer so you
> can do you own commits.
>
> If you would like to get involved then I am happy to help get you set
> up. Just ping an e-mail to the users list. I'd like to keep it on the
> users list so the info is there to help anyone else who wants to get
> started with building Tomcat.
>
> Mark
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: users-help@tomcat.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tomcat.apache.org
For additional commands, e-mail: users-help@tomcat.apache.org