Please remove documentation pointer

Please remove documentation pointer

[Tobias Peters]

Hi all,

Alsa's documentation webbage "http://www.alsa-project.org/documentation.php3"
contains a link in section "ALSA 0.9.x Developer documentation" that
points to outdated documentation:

This link is labled "Howto use the ALSA API", and it points to
"http://www.op.net/~pbd/alsa-audio.html". The example programs presented
there do not work with the current alsa library. This link should at
least be moved out of section "ALSA 0.9.x Developer documentation". It's
quite confusing as it is now.

The only existing documentation on how to do full duplex audio
applications that I found seems to be the C source code of the jack audio
server. Maybe you can put a link to it's file "alsa_driver.c" in place of
the above link. (But this could have the side effect that any future alsa
audio application that uses full duplex is a derivative work of jack and
thus has to be licensed under the GPL)

  Tobias




-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[tomasz motylewski]

On Mon, 15 Jul 2002, Tobias Peters wrote:

> Alsa's documentation webbage "http://www.alsa-project.org/documentation.php3"
> contains a link in section "ALSA 0.9.x Developer documentation" that
> points to outdated documentation:
> 
> This link is labled "Howto use the ALSA API", and it points to
> "http://www.op.net/~pbd/alsa-audio.html". The example programs presented
> there do not work with the current alsa library. This link should at
> least be moved out of section "ALSA 0.9.x Developer documentation". It's
> quite confusing as it is now.

I have said the same over a month ago. No reaction.

--
Tomasz Motylewski



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[Patrick Shirkey]

tomasz motylewski wrote:
> On Mon, 15 Jul 2002, Tobias Peters wrote:
> 
> 
>>Alsa's documentation webbage "http://www.alsa-project.org/documentation.php3"
>>contains a link in section "ALSA 0.9.x Developer documentation" that
>>points to outdated documentation:
>>
>>This link is labled "Howto use the ALSA API", and it points to
>>"http://www.op.net/~pbd/alsa-audio.html". The example programs presented
>>there do not work with the current alsa library. This link should at
>>least be moved out of section "ALSA 0.9.x Developer documentation". It's
>>quite confusing as it is now.
> 
> 
> I have said the same over a month ago. No reaction.
> 

Not true.

Paul said that the document clearly states that it is unfinished and I 
said if you make any changes I will fix the document and put it up on 
the alsa server directly.

The document has a lot of useful info but has become outdated.
  If you know what the problems are then submit a fix.

That's what being a part of the Linux community is all about IMO.


-- 
Patrick Shirkey - Boost Hardware Ltd.
For the discerning hardware connoisseur
Http://www.boosthardware.com
Http://www.boosthardware.com/LAU/guide/
========================================



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[tomasz motylewski]

> 
> Not true.
> 
> Paul said that the document clearly states that it is unfinished and I 
> said if you make any changes I will fix the document and put it up on 
> the alsa server directly.
> 
> The document has a lot of useful info but has become outdated.
>   If you know what the problems are then submit a fix.


I did:

Date: Mon, 3 Jun 2002 21:47:07 +0200 (CEST)
From: tomasz motylewski <tom@bfad.de>
To: pbd@users.sourceforge.net
Subject: wrong snd_pcm_open example code.


On http://www.op.net/~pbd/alsa-audio.html#captureex you wrote:

capture_handle = snd_pcm_open (argv[1], SND_PCM_STREAM_CAPTURE, 0)

The real ALSA9 API is 

err = snd_pcm_open(&chandle, cdevice, SND_PCM_STREAM_CAPTURE, 0)

Could you please currect this?

In my opinion example programs are the best form od documentation, but not
working examples are the worst form of misinformation.

------------------

No answer.



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[Patrick Shirkey]

tomasz motylewski wrote:
>>Not true.
>>
>>Paul said that the document clearly states that it is unfinished and I 
>>said if you make any changes I will fix the document and put it up on 
>>the alsa server directly.
>>
>>The document has a lot of useful info but has become outdated.
>>  If you know what the problems are then submit a fix.
> 
> 
> 
> I did:
> 
> Date: Mon, 3 Jun 2002 21:47:07 +0200 (CEST)
> From: tomasz motylewski <tom@bfad.de>
> To: pbd@users.sourceforge.net
> Subject: wrong snd_pcm_open example code.
> 
> 
> On http://www.op.net/~pbd/alsa-audio.html#captureex you wrote:
> 
> capture_handle = snd_pcm_open (argv[1], SND_PCM_STREAM_CAPTURE, 0)
> 
> The real ALSA9 API is 
> 
> err = snd_pcm_open(&chandle, cdevice, SND_PCM_STREAM_CAPTURE, 0)
> 
> Could you please currect this?
> 
> In my opinion example programs are the best form od documentation, but not
> working examples are the worst form of misinformation.
> 
> ------------------
> 
> No answer.
> 

Like he said he is a busy person.

Is that all that is wrong with the document? I was under the impression 
there was more and was waiting for you to send it to the list so other 
people could verify it.

Paul - Are you ok with me putting the page on the alsa server as fully 
fledged ALSA documentation which other can contribute to without having 
to get your permission?

You have it licensed as GPL so I assume it is not a big deal to you if I 
do? Have you considered changing it to FDL instead?

-- 
Patrick Shirkey - Boost Hardware Ltd.
For the discerning hardware connoisseur
Http://www.boosthardware.com
Http://www.boosthardware.com/LAU/guide/
========================================



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[Paul Davis]

>> 
>> Not true.
>> 
>> Paul said that the document clearly states that it is unfinished and I 
>> said if you make any changes I will fix the document and put it up on 
>> the alsa server directly.
>> 
>> The document has a lot of useful info but has become outdated.
>>   If you know what the problems are then submit a fix.
>
>
>I did:

i will have a new version of the document with working examples in
about 1 hour or maybe 2.

--p


-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[Paul Davis]

>The only existing documentation on how to do full duplex audio
>applications that I found seems to be the C source code of the jack audio
>server. Maybe you can put a link to it's file "alsa_driver.c" in place of
>the above link. (But this could have the side effect that any future alsa
>audio application that uses full duplex is a derivative work of jack and
>thus has to be licensed under the GPL)

this is true. its also true of the examples in my tutorial. if you
don't want the GPL, don't use my time, or my work, or my tutorial.

--p


-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf

Re: Please remove documentation pointer

[Paul Davis]

>This link is labled "Howto use the ALSA API", and it points to
>"http://www.op.net/~pbd/alsa-audio.html". The example programs presented
>there do not work with the current alsa library. This link should at
>least be moved out of section "ALSA 0.9.x Developer documentation". It's
>quite confusing as it is now.

I removed the "minimal full duplex example". The other 3 examples now
contain working (though not useful) code.

>The only existing documentation on how to do full duplex audio
>applications that I found seems to be the C source code of the jack audio
>server. 

ecasound probably has an example too, and perhaps GLAME. 

the reader of my document is referred to JACK, not so much as an
example, but as an alternative to messing around with the ALSA model
and API.

--p


-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf