* Re: YP documentation survey
2014-09-30 18:22 ` Chris Hallinan
@ 2014-09-30 18:30 ` Rifenbark, Scott M
2014-09-30 20:05 ` Rifenbark, Scott M
2014-10-03 15:08 ` Trevor Woerner
2 siblings, 0 replies; 10+ messages in thread
From: Rifenbark, Scott M @ 2014-09-30 18:30 UTC (permalink / raw)
To: Chris Hallinan, Jeff Osier-Mixon; +Cc: Yocto Project
[-- Attachment #1: Type: text/plain, Size: 2969 bytes --]
Sounds like a make problem on the mega-manual fail. I will look at that file and make sure that I have or at least am checking for all the various other manuals in HTML form that must exist in order for mega-manual to make. Regarding the dev-manual failure I would be interested in seeing what dependencies were causing the issue.
I am glad for the "straight A"... that is good to hear Chris.
Thanks,
Scott
From: yocto-bounces@yoctoproject.org [mailto:yocto-bounces@yoctoproject.org] On Behalf Of Chris Hallinan
Sent: Tuesday, September 30, 2014 11:22 AM
To: Jeff Osier-Mixon
Cc: Yocto Project
Subject: Re: [yocto] YP documentation survey
You forgot the fourth question:
- Who reads the docs? ;)
In all seriousness, the YP has some of the best docs I've ever seen come out of an open source project.
My only comment: make it easier to build the latest docs from git. I seem to always hit errors, and I've seen other posts about that, too. I just did a quick make DOC=mega-manual on Daisy, and it failed with:
"tar: mega-manual.html: Cannot stat: No such file or directory"
make DOC=dev-manual failed due to missing dependencies, and in the 30 seconds I spent while writing this e-mail, I couldn't figure out what to install on my U14.04 host to satisfy it.
I don't have much use/fondness for html docs. Give me a searchable PDF any day.
Another suggestion might be to include a setup script that makes sure the proper packages are installed.
All in all, I give the docs a straight 'A' for being well written, informative, and nearly always relatively current, but then, I don't read the docs... ;)
My $0.02
Let the comments fly ;)
-Chris
On Tue, Sep 30, 2014 at 1:43 PM, Jeff Osier-Mixon <jefro@jefro.net<mailto:jefro@jefro.net>> wrote:
Hello - this is the first in a series of short surveys to find out how
the Yocto Project core team can continue to deliver world-class tools,
templates, and processes for creating embedded Linux operating
systems. We will try to keep the surveys short, but we strongly
encourage you to provide information and opinions on all questions.
The more information you provide, the better the Yocto Project will
be.
We appreciate all responses, either on the survey, on this thread, or
privately back to me. If you respond privately, your comments will be
kept anonymous unless otherwise specified.
We're starting with documentation.
https://www.surveymonkey.com/r/SJVQT5M
- Does the Yocto Project documentation serve your needs?
- What do you like best about the documentation?
- What do you notice that is missing?
Thanks
--
Jeff Osier-Mixon @Intel
Yocto Project Community Manager http://yoctoproject.org
--
_______________________________________________
yocto mailing list
yocto@yoctoproject.org<mailto:yocto@yoctoproject.org>
https://lists.yoctoproject.org/listinfo/yocto
--
Life is like Linux - it never stands still.
[-- Attachment #2: Type: text/html, Size: 8696 bytes --]
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: YP documentation survey
2014-09-30 18:22 ` Chris Hallinan
2014-09-30 18:30 ` Rifenbark, Scott M
@ 2014-09-30 20:05 ` Rifenbark, Scott M
2014-10-03 15:08 ` Trevor Woerner
2 siblings, 0 replies; 10+ messages in thread
From: Rifenbark, Scott M @ 2014-09-30 20:05 UTC (permalink / raw)
To: Chris Hallinan, Jeff Osier-Mixon; +Cc: Yocto Project
[-- Attachment #1: Type: text/plain, Size: 2869 bytes --]
I could not replicate the failure here. I cloned the latest poky and then checked out a branch based on the 'yocto-1.6' tag. I was able to 'make DOC=mega-manual' and 'make DOC=dev-manual' with no issues. If you want, you can email me directly with more details of how it is failing on your end.
Thanks,
Scott
From: yocto-bounces@yoctoproject.org [mailto:yocto-bounces@yoctoproject.org] On Behalf Of Chris Hallinan
Sent: Tuesday, September 30, 2014 11:22 AM
To: Jeff Osier-Mixon
Cc: Yocto Project
Subject: Re: [yocto] YP documentation survey
You forgot the fourth question:
- Who reads the docs? ;)
In all seriousness, the YP has some of the best docs I've ever seen come out of an open source project.
My only comment: make it easier to build the latest docs from git. I seem to always hit errors, and I've seen other posts about that, too. I just did a quick make DOC=mega-manual on Daisy, and it failed with:
"tar: mega-manual.html: Cannot stat: No such file or directory"
make DOC=dev-manual failed due to missing dependencies, and in the 30 seconds I spent while writing this e-mail, I couldn't figure out what to install on my U14.04 host to satisfy it.
I don't have much use/fondness for html docs. Give me a searchable PDF any day.
Another suggestion might be to include a setup script that makes sure the proper packages are installed.
All in all, I give the docs a straight 'A' for being well written, informative, and nearly always relatively current, but then, I don't read the docs... ;)
My $0.02
Let the comments fly ;)
-Chris
On Tue, Sep 30, 2014 at 1:43 PM, Jeff Osier-Mixon <jefro@jefro.net<mailto:jefro@jefro.net>> wrote:
Hello - this is the first in a series of short surveys to find out how
the Yocto Project core team can continue to deliver world-class tools,
templates, and processes for creating embedded Linux operating
systems. We will try to keep the surveys short, but we strongly
encourage you to provide information and opinions on all questions.
The more information you provide, the better the Yocto Project will
be.
We appreciate all responses, either on the survey, on this thread, or
privately back to me. If you respond privately, your comments will be
kept anonymous unless otherwise specified.
We're starting with documentation.
https://www.surveymonkey.com/r/SJVQT5M
- Does the Yocto Project documentation serve your needs?
- What do you like best about the documentation?
- What do you notice that is missing?
Thanks
--
Jeff Osier-Mixon @Intel
Yocto Project Community Manager http://yoctoproject.org
--
_______________________________________________
yocto mailing list
yocto@yoctoproject.org<mailto:yocto@yoctoproject.org>
https://lists.yoctoproject.org/listinfo/yocto
--
Life is like Linux - it never stands still.
[-- Attachment #2: Type: text/html, Size: 8322 bytes --]
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: YP documentation survey
2014-09-30 18:22 ` Chris Hallinan
2014-09-30 18:30 ` Rifenbark, Scott M
2014-09-30 20:05 ` Rifenbark, Scott M
@ 2014-10-03 15:08 ` Trevor Woerner
2014-10-08 20:56 ` Denys Dmytriyenko
2 siblings, 1 reply; 10+ messages in thread
From: Trevor Woerner @ 2014-10-03 15:08 UTC (permalink / raw)
To: Chris Hallinan, Jeff Osier-Mixon; +Cc: Yocto Project
[-- Attachment #1: Type: text/plain, Size: 1041 bytes --]
On 09/30/14 14:22, Chris Hallinan wrote:
> My only comment: make it easier to build the latest docs from git. I
> seem to always hit errors, and I've seen other posts about that, too.
> I just did a quick make DOC=mega-manual on Daisy, and it failed with:
> "tar: mega-manual.html: Cannot stat: No such file or directory"
>
> make DOC=dev-manual failed due to missing dependencies, and in the 30
> seconds I spent while writing this e-mail, I couldn't figure out what
> to install on my U14.04 host to satisfy it.
>
> I don't have much use/fondness for html docs. Give me a searchable
> PDF any day.
>
Attached is the little shell script I run right after I run my other
shell script that updates all the layer repositories I follow :-)
I only build the PDFs and I've never been successful building the mega
manual either (pdf, html, or otherwise).
Getting the docs to build on my openSUSE system was also a challenge
since there are two packages which provide "docbook2x-texi" and I need
the _other_ one :-)
[-- Attachment #2: build_yocto_docs.sh --]
[-- Type: application/x-shellscript, Size: 468 bytes --]
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: YP documentation survey
2014-10-03 15:08 ` Trevor Woerner
@ 2014-10-08 20:56 ` Denys Dmytriyenko
2014-10-08 22:24 ` Rifenbark, Scott M
2014-10-09 10:19 ` Burton, Ross
0 siblings, 2 replies; 10+ messages in thread
From: Denys Dmytriyenko @ 2014-10-08 20:56 UTC (permalink / raw)
To: Trevor Woerner; +Cc: Yocto Project
For me, it fails with:
fop: command not found
Trying to install fop shows me about 100 (!) Java dependencies... Is this
expected?
--
Denys
On Fri, Oct 03, 2014 at 11:08:34AM -0400, Trevor Woerner wrote:
>
> On 09/30/14 14:22, Chris Hallinan wrote:
> > My only comment: make it easier to build the latest docs from git. I
> > seem to always hit errors, and I've seen other posts about that, too.
> > I just did a quick make DOC=mega-manual on Daisy, and it failed with:
> > "tar: mega-manual.html: Cannot stat: No such file or directory"
> >
> > make DOC=dev-manual failed due to missing dependencies, and in the 30
> > seconds I spent while writing this e-mail, I couldn't figure out what
> > to install on my U14.04 host to satisfy it.
> >
> > I don't have much use/fondness for html docs. Give me a searchable
> > PDF any day.
> >
>
> Attached is the little shell script I run right after I run my other
> shell script that updates all the layer repositories I follow :-)
>
> I only build the PDFs and I've never been successful building the mega
> manual either (pdf, html, or otherwise).
>
> Getting the docs to build on my openSUSE system was also a challenge
> since there are two packages which provide "docbook2x-texi" and I need
> the _other_ one :-)
> --
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: YP documentation survey
2014-10-08 20:56 ` Denys Dmytriyenko
@ 2014-10-08 22:24 ` Rifenbark, Scott M
2014-10-09 10:19 ` Burton, Ross
1 sibling, 0 replies; 10+ messages in thread
From: Rifenbark, Scott M @ 2014-10-08 22:24 UTC (permalink / raw)
To: Denys Dmytriyenko, Trevor Woerner; +Cc: Yocto Project
Have you ensured that the host system has all the packages needed to build the docs? The section http://www.yoctoproject.org/docs/1.6.1/ref-manual/ref-manual.html#required-packages-for-the-host-development-system lists out the requirements needed depending on what you are building and the distro on the host system.
Scott
>-----Original Message-----
>From: yocto-bounces@yoctoproject.org [mailto:yocto-
>bounces@yoctoproject.org] On Behalf Of Denys Dmytriyenko
>Sent: Wednesday, October 08, 2014 1:57 PM
>To: Trevor Woerner
>Cc: Yocto Project
>Subject: Re: [yocto] YP documentation survey
>
>For me, it fails with:
>
>fop: command not found
>
>Trying to install fop shows me about 100 (!) Java dependencies... Is this
>expected?
>
>--
>Denys
>
>
>On Fri, Oct 03, 2014 at 11:08:34AM -0400, Trevor Woerner wrote:
>>
>> On 09/30/14 14:22, Chris Hallinan wrote:
>> > My only comment: make it easier to build the latest docs from git. I
>> > seem to always hit errors, and I've seen other posts about that, too.
>> > I just did a quick make DOC=mega-manual on Daisy, and it failed with:
>> > "tar: mega-manual.html: Cannot stat: No such file or directory"
>> >
>> > make DOC=dev-manual failed due to missing dependencies, and in the 30
>> > seconds I spent while writing this e-mail, I couldn't figure out what
>> > to install on my U14.04 host to satisfy it.
>> >
>> > I don't have much use/fondness for html docs. Give me a searchable
>> > PDF any day.
>> >
>>
>> Attached is the little shell script I run right after I run my other
>> shell script that updates all the layer repositories I follow :-)
>>
>> I only build the PDFs and I've never been successful building the mega
>> manual either (pdf, html, or otherwise).
>>
>> Getting the docs to build on my openSUSE system was also a challenge
>> since there are two packages which provide "docbook2x-texi" and I need
>> the _other_ one :-)
>
>
>> --
>> _______________________________________________
>> yocto mailing list
>> yocto@yoctoproject.org
>> https://lists.yoctoproject.org/listinfo/yocto
>
>--
>_______________________________________________
>yocto mailing list
>yocto@yoctoproject.org
>https://lists.yoctoproject.org/listinfo/yocto
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: YP documentation survey
2014-10-08 20:56 ` Denys Dmytriyenko
2014-10-08 22:24 ` Rifenbark, Scott M
@ 2014-10-09 10:19 ` Burton, Ross
2014-10-09 13:55 ` Denys Dmytriyenko
1 sibling, 1 reply; 10+ messages in thread
From: Burton, Ross @ 2014-10-09 10:19 UTC (permalink / raw)
To: Denys Dmytriyenko; +Cc: Yocto Project
On 8 October 2014 21:56, Denys Dmytriyenko <denis@denix.org> wrote:
> fop: command not found
>
> Trying to install fop shows me about 100 (!) Java dependencies... Is this
> expected?
Yes, FOP is implemented in Java and Java libraries are quite granular.
It's just XSLT so you can likely use a different XSLT processor if
this bothers you sufficiently (but you may need to buy a license for a
commercial processor).
Ross
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: YP documentation survey
2014-10-09 10:19 ` Burton, Ross
@ 2014-10-09 13:55 ` Denys Dmytriyenko
0 siblings, 0 replies; 10+ messages in thread
From: Denys Dmytriyenko @ 2014-10-09 13:55 UTC (permalink / raw)
To: Burton, Ross; +Cc: Yocto Project
On Thu, Oct 09, 2014 at 11:19:15AM +0100, Burton, Ross wrote:
> On 8 October 2014 21:56, Denys Dmytriyenko <denis@denix.org> wrote:
> > fop: command not found
> >
> > Trying to install fop shows me about 100 (!) Java dependencies... Is this
> > expected?
>
> Yes, FOP is implemented in Java and Java libraries are quite granular.
>
> It's just XSLT so you can likely use a different XSLT processor if
> this bothers you sufficiently (but you may need to buy a license for a
> commercial processor).
Ok, I see. It's unfortunate, but understood. I ended up installing it on my
other machine which has Java, so it wasn't as painful. Thanks.
--
Denys
^ permalink raw reply [flat|nested] 10+ messages in thread