Documentation suggestion

bridged with qnx.development_tools
Post Reply
Bill Caroselli

Documentation suggestion

Post by Bill Caroselli » Tue Mar 16, 2004 1:57 pm

Hi Steve,

Most of the functions in the C library reference for QNX4 included
example code. This very often makes it much easier to figure out how
to use a given function.

Are there plans to include examples for the functions in QNX6?
(If not, there should be.)

Steve Reid

Re: Documentation suggestion

Post by Steve Reid » Tue Mar 16, 2004 2:45 pm

Bill Caroselli <qtps@earthlink.net> wrote:
Hi Steve,

Most of the functions in the C library reference for QNX4 included
example code. This very often makes it much easier to figure out how
to use a given function.

Are there plans to include examples for the functions in QNX6?
(If not, there should be.)
There are always plans to include examples. :-)

The challenge is to find an example that illustrates the function well, but
isn't 10,000 lines long. Then, you have to make sure the examples all stay
up-to-date. Are there any functions in particular that you'd like examples
for?

------------------------------------------
Steve Reid stever@qnx.com
TechPubs (Technical Publications)
QNX Software Systems
------------------------------------------

Bill Caroselli

Re: Documentation suggestion

Post by Bill Caroselli » Tue Mar 16, 2004 3:23 pm

Steve Reid <stever@sreid.ott.qnx.com> wrote:
SR > Bill Caroselli <qtps@earthlink.net> wrote:
Hi Steve,

Most of the functions in the C library reference for QNX4 included
example code. This very often makes it much easier to figure out how
to use a given function.

Are there plans to include examples for the functions in QNX6?
(If not, there should be.)
SR > There are always plans to include examples. :-)

SR > The challenge is to find an example that illustrates the function well, but
SR > isn't 10,000 lines long. Then, you have to make sure the examples all stay
SR > up-to-date. Are there any functions in particular that you'd like examples
SR > for?

Well, pthread_*() ?

Just about everything else should have examples from QNX4 that that you
can just copy over, no?

I know you folks are busy. Keep up the good work.

What new documentation features can we look forward to in 6.3?

Steve Reid

Re: Documentation suggestion

Post by Steve Reid » Tue Mar 16, 2004 3:57 pm

Bill Caroselli <qtps@earthlink.net> wrote:
Just about everything else should have examples from QNX4 that that you
can just copy over, no?
Possibly, but we'd have to check them.
I know you folks are busy. Keep up the good work.
Thanks.
What new documentation features can we look forward to in 6.3?
There's (finally) a Neutrino User's Guide that replaces the Sys Admin
guide, and also a new IDE User's Guide. Of course, we've also updated
the rest of the docs where appropriate.

------------------------------------------
Steve Reid stever@qnx.com
TechPubs (Technical Publications)
QNX Software Systems
------------------------------------------

Wojtek Lerch

Re: Documentation suggestion

Post by Wojtek Lerch » Tue Mar 16, 2004 4:18 pm

Bill Caroselli wrote:
Steve Reid <stever@sreid.ott.qnx.com> wrote:
SR > The challenge is to find an example that illustrates the function well, but
SR > isn't 10,000 lines long. Then, you have to make sure the examples all stay
SR > up-to-date. Are there any functions in particular that you'd like examples
SR > for?

Well, pthread_*() ?
Wouldn't it be more productive to let our docs people work on stuff that
isn't already covered in 64 books you can buy at amazon.com? :-)

Bill Caroselli

Re: Documentation suggestion

Post by Bill Caroselli » Tue Mar 16, 2004 6:59 pm

Steve Reid <stever@sreid.ott.qnx.com> wrote:
SR > Bill Caroselli <qtps@earthlink.net> wrote:
I know you folks are busy. Keep up the good work.
SR > Thanks.
What new documentation features can we look forward to in 6.3?
SR > There's (finally) a Neutrino User's Guide that replaces the Sys Admin
SR > guide, and also a new IDE User's Guide. Of course, we've also updated
SR > the rest of the docs where appropriate.

Can we access the Sys Admin Guice now?

Rennie Allen

Re: Documentation suggestion

Post by Rennie Allen » Wed Mar 17, 2004 12:28 am

Wojtek Lerch wrote:
Wouldn't it be more productive to let our docs people work on stuff that
isn't already covered in 64 books you can buy at amazon.com? :-)
Yup, but you know what ? Licensing something like Butenhofs' book in an
electronic version to include with the IDE would sure be slick. Sure it
could be amortized in the cost of PE ;-)

Steve Reid

Re: Documentation suggestion

Post by Steve Reid » Thu Mar 18, 2004 1:30 pm

Bill Caroselli <qtps@earthlink.net> wrote:
Can we access the Sys Admin Guice now?
The work-in-progress Sys Admin book was inadvertently left off of the new
website, but someone is looking into adding it.

------------------------------------------
Steve Reid stever@qnx.com
TechPubs (Technical Publications)
QNX Software Systems
------------------------------------------

Bill Caroselli

Re: Documentation suggestion (minor Oops)

Post by Bill Caroselli » Mon Mar 22, 2004 3:23 pm

Hi Steve

Here's a little correction. The helpviewer page for eaccess() says that
you need the include file <libgen.h>, which is correct. But you also
need <unistd.h> for the *_OK constants. You might want to add that for
the next release.

The access() function seems to have this correct.

Steve Reid

Re: Documentation suggestion (minor Oops)

Post by Steve Reid » Mon Mar 22, 2004 3:25 pm

Bill Caroselli <qtps@earthlink.net> wrote:
Hi Steve

Here's a little correction. The helpviewer page for eaccess() says that
you need the include file <libgen.h>, which is correct. But you also
need <unistd.h> for the *_OK constants. You might want to add that for
the next release.

The access() function seems to have this correct.
I'll pass this on to the writer. Thanks for mentioning this.

------------------------------------------
Steve Reid stever@qnx.com
TechPubs (Technical Publications)
QNX Software Systems
------------------------------------------

Bill Caroselli

Re: Documentation suggestion

Post by Bill Caroselli » Thu Dec 09, 2004 4:28 pm

One more suggestion for the next major release of documentation.

In the Widget Library section it would be nice if there were links at the
top of each widget page for "New Resources" and "Inherited Resources".

Some of the widget pages are quite large. This would make it easier to
find these important sections.

Steve Reid

Re: Documentation suggestion

Post by Steve Reid » Thu Dec 09, 2004 7:52 pm

Bill Caroselli <qtps@earthlink.net> wrote:
One more suggestion for the next major release of documentation.

In the Widget Library section it would be nice if there were links at the
top of each widget page for "New Resources" and "Inherited Resources".

Some of the widget pages are quite large. This would make it easier to
find these important sections.
I've thought about in the past, and so has Drew. He's adding it to his
to-do list. Thanks for the suggestion.

------------------------------------------
Steve Reid stever@qnx.com
TechPubs (Technical Publications)
QNX Software Systems
------------------------------------------

Post Reply

Return to “qnx.development_tools”