You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Alex Hitchins <al...@shapeblue.com> on 2014/02/03 17:47:05 UTC

API Documentation Job

All,

Has anyone recently been able to generate the API documentation, as described here? https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Generate+CloudStack+API+Documentation


I've been trying without success. I know Paul Angus has also been having issues with this. I just wanted to see if it was a bigger issue.

Many thanks,

Alex
Need Enterprise Grade Support for Apache CloudStack?
Our CloudStack Infrastructure Support<http://shapeblue.com/cloudstack-infrastructure-support/> offers the best 24/7 SLA for CloudStack Environments.

Apache CloudStack Bootcamp training courses

**NEW!** CloudStack 4.2.1 training<http://shapeblue.com/cloudstack-training/>
18th-19th February 2014, Brazil. Classroom<http://shapeblue.com/cloudstack-training/>
17th-23rd March 2014, Region A. Instructor led, On-line<http://shapeblue.com/cloudstack-training/>
24th-28th March 2014, Region B. Instructor led, On-line<http://shapeblue.com/cloudstack-training/>
16th-20th June 2014, Region A. Instructor led, On-line<http://shapeblue.com/cloudstack-training/>
23rd-27th June 2014, Region B. Instructor led, On-line<http://shapeblue.com/cloudstack-training/>

This email and any attachments to it may be confidential and are intended solely for the use of the individual to whom it is addressed. Any views or opinions expressed are solely those of the author and do not necessarily represent those of Shape Blue Ltd or related companies. If you are not the intended recipient of this email, you must neither take any action based upon its contents, nor copy or show it to anyone. Please contact the sender if you believe you have received this email in error. Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue Services India LLP is a company incorporated in India and is operated under license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in Brasil and is operated under license from Shape Blue Ltd. ShapeBlue is a registered trademark.

RE: API Documentation Job

Posted by Alex Hitchins <al...@shapeblue.com>.
Hi Ian,

I think this might be down to dos/unix formatting.

[INFO] --- exec-maven-plugin:1.2.1:exec (compile) @ cloud-apidoc ---
./build-apidoc.sh: line 18: $'\r': command not found
./build-apidoc.sh: line 19: $'\r': command not found
./build-apidoc.sh: line 24: $'shift\r': command not found
./build-apidoc.sh: line 26: $'shift\r': command not found
./build-apidoc.sh: line 28: $'shift\r': command not found
./build-apidoc.sh: line 29: $'\r': command not found
./build-apidoc.sh: line 30: syntax error near unexpected token `$'\r''
'/build-apidoc.sh: line 30: `canonical_readlink ()

I think Paul Angus has got it to build successfully now. I'll try his route.



Alex Hitchins
T: +44 1892 523 587
M: +44 7788 423 969

-----Original Message-----
From: Ian Duffy [mailto:ian@ianduffy.ie]
Sent: 04 February 2014 00:17
To: CloudStack Dev
Subject: RE: API Documentation Job

Can you paste the errors/output you get?
On 3 Feb 2014 22:13, "Alex Hitchins" <al...@shapeblue.com> wrote:

> It still complains for me. I'll refresh myself tomorrow morning and
> see if I get anywhere.
>
> One thing I haven't tried is checking out the 4.2.1 branch, I've been
> doing it all on master.
>
> Thank you for trying Ian. I'm sure I'll get there soon.
>
>
>
> Alex Hitchins
> T: +44 1892 523 587
> M: +44 7788 423 969
>
> -----Original Message-----
> From: Ian Duffy [mailto:ian@ianduffy.ie]
> Sent: 03 February 2014 21:56
> To: CloudStack Dev
> Subject: Re: API Documentation Job
>
> Didn't come across any issues when trying to compile it.
>
> Did a usual full compile of mvn -Pdeveloper clean install
> Documentation was generated and placed into
> /tools/apidoc/target/apidoc.tar.bz2
>
> http://people.apache.org/~duffy/apidocs/xmldoc/html/
>
> The header reads 4.2.0 due to a hard coded value in the templates.
>
>
>
>
> On 3 February 2014 16:47, Alex Hitchins <al...@shapeblue.com>
> wrote:
>
> > All,
> >
> > Has anyone recently been able to generate the API documentation, as
> > described here?
> > https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Genera
> > te
> > +CloudStack+API+Documentation
> >
> >
> > I've been trying without success. I know Paul Angus has also been
> > having issues with this. I just wanted to see if it was a bigger issue.
> >
> > Many thanks,
> >
> > Alex
> > Need Enterprise Grade Support for Apache CloudStack?
> > Our CloudStack Infrastructure Support<
> > http://shapeblue.com/cloudstack-infrastructure-support/> offers the
> > best
> > 24/7 SLA for CloudStack Environments.
> >
> > Apache CloudStack Bootcamp training courses
> >
> > **NEW!** CloudStack 4.2.1 training<
> > http://shapeblue.com/cloudstack-training/>
> > 18th-19th February 2014, Brazil. Classroom<
> > http://shapeblue.com/cloudstack-training/>
> > 17th-23rd March 2014, Region A. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> > 24th-28th March 2014, Region B. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> > 16th-20th June 2014, Region A. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> > 23rd-27th June 2014, Region B. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> >
> > This email and any attachments to it may be confidential and are
> > intended solely for the use of the individual to whom it is addressed.
> > Any views or opinions expressed are solely those of the author and
> > do not necessarily represent those of Shape Blue Ltd or related
> > companies. If you are not the intended recipient of this email, you
> > must neither take any action based upon its contents, nor copy or
> > show it to anyone. Please contact the sender if you believe you have
> > received this email in error. Shape Blue Ltd is a company
> > incorporated in England & Wales. ShapeBlue Services India LLP is a
> > company incorporated in India and is operated under license from
> > Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a company
> > incorporated in Brasil and is operated under license from Shape Blue
> > Ltd. ShapeBlue is a
> registered trademark.
> >
> This email and any attachments to it may be confidential and are
> intended solely for the use of the individual to whom it is addressed.
> Any views or opinions expressed are solely those of the author and do
> not necessarily represent those of Shape Blue Ltd or related
> companies. If you are not the intended recipient of this email, you
> must neither take any action based upon its contents, nor copy or show
> it to anyone. Please contact the sender if you believe you have
> received this email in error. Shape Blue Ltd is a company incorporated
> in England & Wales. ShapeBlue Services India LLP is a company
> incorporated in India and is operated under license from Shape Blue
> Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in
> Brasil and is operated under license from Shape Blue Ltd. ShapeBlue is a registered trademark.
>
This email and any attachments to it may be confidential and are intended solely for the use of the individual to whom it is addressed. Any views or opinions expressed are solely those of the author and do not necessarily represent those of Shape Blue Ltd or related companies. If you are not the intended recipient of this email, you must neither take any action based upon its contents, nor copy or show it to anyone. Please contact the sender if you believe you have received this email in error. Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue Services India LLP is a company incorporated in India and is operated under license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in Brasil and is operated under license from Shape Blue Ltd. ShapeBlue is a registered trademark.

RE: API Documentation Job

Posted by Ian Duffy <ia...@ianduffy.ie>.
Can you paste the errors/output you get?
On 3 Feb 2014 22:13, "Alex Hitchins" <al...@shapeblue.com> wrote:

> It still complains for me. I'll refresh myself tomorrow morning and see if
> I get anywhere.
>
> One thing I haven't tried is checking out the 4.2.1 branch, I've been
> doing it all on master.
>
> Thank you for trying Ian. I'm sure I'll get there soon.
>
>
>
> Alex Hitchins
> T: +44 1892 523 587
> M: +44 7788 423 969
>
> -----Original Message-----
> From: Ian Duffy [mailto:ian@ianduffy.ie]
> Sent: 03 February 2014 21:56
> To: CloudStack Dev
> Subject: Re: API Documentation Job
>
> Didn't come across any issues when trying to compile it.
>
> Did a usual full compile of mvn -Pdeveloper clean install Documentation
> was generated and placed into
> /tools/apidoc/target/apidoc.tar.bz2
>
> http://people.apache.org/~duffy/apidocs/xmldoc/html/
>
> The header reads 4.2.0 due to a hard coded value in the templates.
>
>
>
>
> On 3 February 2014 16:47, Alex Hitchins <al...@shapeblue.com>
> wrote:
>
> > All,
> >
> > Has anyone recently been able to generate the API documentation, as
> > described here?
> > https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Generate
> > +CloudStack+API+Documentation
> >
> >
> > I've been trying without success. I know Paul Angus has also been
> > having issues with this. I just wanted to see if it was a bigger issue.
> >
> > Many thanks,
> >
> > Alex
> > Need Enterprise Grade Support for Apache CloudStack?
> > Our CloudStack Infrastructure Support<
> > http://shapeblue.com/cloudstack-infrastructure-support/> offers the
> > best
> > 24/7 SLA for CloudStack Environments.
> >
> > Apache CloudStack Bootcamp training courses
> >
> > **NEW!** CloudStack 4.2.1 training<
> > http://shapeblue.com/cloudstack-training/>
> > 18th-19th February 2014, Brazil. Classroom<
> > http://shapeblue.com/cloudstack-training/>
> > 17th-23rd March 2014, Region A. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> > 24th-28th March 2014, Region B. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> > 16th-20th June 2014, Region A. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> > 23rd-27th June 2014, Region B. Instructor led, On-line<
> > http://shapeblue.com/cloudstack-training/>
> >
> > This email and any attachments to it may be confidential and are
> > intended solely for the use of the individual to whom it is addressed.
> > Any views or opinions expressed are solely those of the author and do
> > not necessarily represent those of Shape Blue Ltd or related
> > companies. If you are not the intended recipient of this email, you
> > must neither take any action based upon its contents, nor copy or show
> > it to anyone. Please contact the sender if you believe you have
> > received this email in error. Shape Blue Ltd is a company incorporated
> > in England & Wales. ShapeBlue Services India LLP is a company
> > incorporated in India and is operated under license from Shape Blue
> > Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in
> > Brasil and is operated under license from Shape Blue Ltd. ShapeBlue is a
> registered trademark.
> >
> This email and any attachments to it may be confidential and are intended
> solely for the use of the individual to whom it is addressed. Any views or
> opinions expressed are solely those of the author and do not necessarily
> represent those of Shape Blue Ltd or related companies. If you are not the
> intended recipient of this email, you must neither take any action based
> upon its contents, nor copy or show it to anyone. Please contact the sender
> if you believe you have received this email in error. Shape Blue Ltd is a
> company incorporated in England & Wales. ShapeBlue Services India LLP is a
> company incorporated in India and is operated under license from Shape Blue
> Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in Brasil
> and is operated under license from Shape Blue Ltd. ShapeBlue is a
> registered trademark.
>

RE: API Documentation Job

Posted by Alex Hitchins <al...@shapeblue.com>.
It still complains for me. I'll refresh myself tomorrow morning and see if I get anywhere.

One thing I haven't tried is checking out the 4.2.1 branch, I've been doing it all on master.

Thank you for trying Ian. I'm sure I'll get there soon.



Alex Hitchins
T: +44 1892 523 587
M: +44 7788 423 969

-----Original Message-----
From: Ian Duffy [mailto:ian@ianduffy.ie]
Sent: 03 February 2014 21:56
To: CloudStack Dev
Subject: Re: API Documentation Job

Didn't come across any issues when trying to compile it.

Did a usual full compile of mvn -Pdeveloper clean install Documentation was generated and placed into
/tools/apidoc/target/apidoc.tar.bz2

http://people.apache.org/~duffy/apidocs/xmldoc/html/

The header reads 4.2.0 due to a hard coded value in the templates.




On 3 February 2014 16:47, Alex Hitchins <al...@shapeblue.com> wrote:

> All,
>
> Has anyone recently been able to generate the API documentation, as
> described here?
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Generate
> +CloudStack+API+Documentation
>
>
> I've been trying without success. I know Paul Angus has also been
> having issues with this. I just wanted to see if it was a bigger issue.
>
> Many thanks,
>
> Alex
> Need Enterprise Grade Support for Apache CloudStack?
> Our CloudStack Infrastructure Support<
> http://shapeblue.com/cloudstack-infrastructure-support/> offers the
> best
> 24/7 SLA for CloudStack Environments.
>
> Apache CloudStack Bootcamp training courses
>
> **NEW!** CloudStack 4.2.1 training<
> http://shapeblue.com/cloudstack-training/>
> 18th-19th February 2014, Brazil. Classroom<
> http://shapeblue.com/cloudstack-training/>
> 17th-23rd March 2014, Region A. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
> 24th-28th March 2014, Region B. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
> 16th-20th June 2014, Region A. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
> 23rd-27th June 2014, Region B. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
>
> This email and any attachments to it may be confidential and are
> intended solely for the use of the individual to whom it is addressed.
> Any views or opinions expressed are solely those of the author and do
> not necessarily represent those of Shape Blue Ltd or related
> companies. If you are not the intended recipient of this email, you
> must neither take any action based upon its contents, nor copy or show
> it to anyone. Please contact the sender if you believe you have
> received this email in error. Shape Blue Ltd is a company incorporated
> in England & Wales. ShapeBlue Services India LLP is a company
> incorporated in India and is operated under license from Shape Blue
> Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in
> Brasil and is operated under license from Shape Blue Ltd. ShapeBlue is a registered trademark.
>
This email and any attachments to it may be confidential and are intended solely for the use of the individual to whom it is addressed. Any views or opinions expressed are solely those of the author and do not necessarily represent those of Shape Blue Ltd or related companies. If you are not the intended recipient of this email, you must neither take any action based upon its contents, nor copy or show it to anyone. Please contact the sender if you believe you have received this email in error. Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue Services India LLP is a company incorporated in India and is operated under license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in Brasil and is operated under license from Shape Blue Ltd. ShapeBlue is a registered trademark.

Re: API Documentation Job

Posted by Ian Duffy <ia...@ianduffy.ie>.
Didn't come across any issues when trying to compile it.

Did a usual full compile of mvn -Pdeveloper clean install
Documentation was generated and placed into
/tools/apidoc/target/apidoc.tar.bz2

http://people.apache.org/~duffy/apidocs/xmldoc/html/

The header reads 4.2.0 due to a hard coded value in the templates.




On 3 February 2014 16:47, Alex Hitchins <al...@shapeblue.com> wrote:

> All,
>
> Has anyone recently been able to generate the API documentation, as
> described here?
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+To+Generate+CloudStack+API+Documentation
>
>
> I've been trying without success. I know Paul Angus has also been having
> issues with this. I just wanted to see if it was a bigger issue.
>
> Many thanks,
>
> Alex
> Need Enterprise Grade Support for Apache CloudStack?
> Our CloudStack Infrastructure Support<
> http://shapeblue.com/cloudstack-infrastructure-support/> offers the best
> 24/7 SLA for CloudStack Environments.
>
> Apache CloudStack Bootcamp training courses
>
> **NEW!** CloudStack 4.2.1 training<
> http://shapeblue.com/cloudstack-training/>
> 18th-19th February 2014, Brazil. Classroom<
> http://shapeblue.com/cloudstack-training/>
> 17th-23rd March 2014, Region A. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
> 24th-28th March 2014, Region B. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
> 16th-20th June 2014, Region A. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
> 23rd-27th June 2014, Region B. Instructor led, On-line<
> http://shapeblue.com/cloudstack-training/>
>
> This email and any attachments to it may be confidential and are intended
> solely for the use of the individual to whom it is addressed. Any views or
> opinions expressed are solely those of the author and do not necessarily
> represent those of Shape Blue Ltd or related companies. If you are not the
> intended recipient of this email, you must neither take any action based
> upon its contents, nor copy or show it to anyone. Please contact the sender
> if you believe you have received this email in error. Shape Blue Ltd is a
> company incorporated in England & Wales. ShapeBlue Services India LLP is a
> company incorporated in India and is operated under license from Shape Blue
> Ltd. Shape Blue Brasil Consultoria Ltda is a company incorporated in Brasil
> and is operated under license from Shape Blue Ltd. ShapeBlue is a
> registered trademark.
>