Outdated SDL documentation

Hi!
I am so sad that, as the 1.2 series has became very stable and mature
(and 1.3 is getting closer), no documentation, FAQ or tutorial was
updated to reflect this maturity.
The lack of updates in this area was already cited in some places,
notably in Gamedev (when some newbie ask for advices on how to begin,
what to use etc.), what is really bad.
Sam and Ryan (and the other bad guys), I have some free time to spent
fixing everything (and I would love to), so please let me know if there
is someone that already began the job.
Goodbye!_______________________________________________________
Novidade no Yahoo! Mail: receba alertas de novas mensagens no seu celular. Registre seu aparelho agora!
http://br.mobile.yahoo.com/mailalertas/

Hi!
I am so sad that, as the 1.2 series has became very stable and mature
(and 1.3 is getting closer), no documentation, FAQ or tutorial was
updated to reflect this maturity.
The lack of updates in this area was already cited in some places,
notably in Gamedev (when some newbie ask for advices on how to begin,
what to use etc.), what is really bad.
Sam and Ryan (and the other bad guys), I have some free time to spent
fixing everything (and I would love to), so please let me know if there
is someone that already began the job.

Great! SDL has been around so long, and so many people have contributed
that I no longer remember all the various places where things are documented.
I notice that English doesn’t appear to be your first language, so rather
than make the updates yourself, could you point at the various places that
need to be updated, and I’ll take care of them?

Thanks!
-Sam Lantinga, Senior Software Engineer, Blizzard Entertainment

Alex (aka Majin) wrote:

I am so sad that, as the 1.2 series has became very stable and mature
(and 1.3 is getting closer), no documentation, FAQ or tutorial was
updated to reflect this maturity.

I think it’s just not made clear enough that the canonical place for SDL
documentation is the Doc Wiki at http://www.libsdl.org/cgi/docwiki.cgi/
(unless I’m mistaken about this myself…), and AFAIK this is up to date.

I just noticed that the SDL 1.2.11 release (at least
SDL-devel-1.2.11-extras.dmg) still ships with outdated documentation.
That’s a mistake, IMHO - these files should be replaced by an
offline-readable snapshot of the wiki. In fact, that was the reason the
wiki was set up in the first place, IIRC. (I’m not sure how to make such
a snapshot, but as I remember this to have been one of the primary
concerns when the wiki software was chosen, I suppose it’s possible. In
the worst case, use wget.)

I hope that with the use of Doxygen in 1.3, the situation will improve
somewhat. The only question is, what to do with the wiki at that time?
If we keep it for 1.3, someone has to make the effort of keeping it
synchronized to Doxygen. If we shut it down (or restrict it to 1.2),
contributing clarifications to the documentation becomes more difficult
for users.

-Christian

Hello !

Nobody should blame Sam or Ryan for a bad or uncomplete
documentation. I think the docu at the moment is pretty complete,
as SDL 1.3 is in some kind fluid, it would not make much sense
to try to document it now. Maybe in two or three months.

Especially Sam does a heck lot of work, he redesigns the API,
implements the Dummy, OpenGL, Win32, GDI Renderer. Everyday
you see commits from him, personally i would built him a marmor
monument.

CU

— Christian Walther escreveu:

“I think it’s just not made clear enough that the canonical place for
SDL documentation is the Doc Wiki at
http://www.libsdl.org/cgi/docwiki.cgi/ (unless I’m mistaken about this
myself…), and AFAIK this is up to date.”

Sorry to disagree, but it is not up to date (at least I couldn’t
find any reference to SDL_GL_ACCELERATED_VISUAL there), and I think a
Wiki should not be the cannonical place for the documentation (the
files distributed in the official release should).

"In fact, that was the reason the wiki was set up in the first place,
IIRC. (I’m not sure how to make such a snapshot, but as I remember
this to have been one of the primary concerns when the wiki software
was chosen, I suppose it’s possible. In the worst case, use wget.

Sorry to disagree again, but “wget” is not a reasonable choice.

"I hope that with the use of Doxygen in 1.3, the situation will improve

somewhat. The only question is, what to do with the wiki at that time?"

Wow, I didn’t even know that DOxygen was being used in 1.3. In fact,
in the time I sent the proposal to the list, I had DOxygen in mind as
one of the tools that would ease my job.

Goodbye!_______________________________________________________
Novidade no Yahoo! Mail: receba alertas de novas mensagens no seu celular. Registre seu aparelho agora!
http://br.mobile.yahoo.com/mailalertas/

Blame Sam or Ryan?!? Oh, come on Torsten… I have volunteered myself
to do ALL the work.
Goodbye!

— Torsten Giebl escreveu:> Hello !

Nobody should blame Sam or Ryan for a bad or uncomplete
documentation. I think the docu at the moment is pretty complete,
as SDL 1.3 is in some kind fluid, it would not make much sense
to try to document it now. Maybe in two or three months.

Especially Sam does a heck lot of work, he redesigns the API,
implements the Dummy, OpenGL, Win32, GDI Renderer. Everyday
you see commits from him, personally i would built him a marmor
monument.

CU


Abra sua conta no Yahoo! Mail: 1GB de espa?o, alertas de e-mail no celular e anti-spam realmente eficaz.
http://mail.yahoo.com.br/

Hello !

Blame Sam or Ryan?!? Oh, come on Torsten… I have volunteered myself
to do ALL the work. Goodbye!

Sorry, I don’t want to blame you :slight_smile:
I meant this in a more general way.

FLTK 1.1 used hand written HTML Pages for documentation.
For FLTK 2 they are using Doxygen + HTMLDOC now.

What the future of the Wiki is for SDL-1.3 ?

It will be still usefull for posting code snippets
and example code, maybe when SDL 1.3 is finished we can
come up with something that uses the docum. from the source, maybe plus an ID
for every SDL command and then we can work up some wiki like thing.

CU

Alex (aka Majin) wrote:

— Christian Walther <@Christian_Walther> escreveu:
“I think it’s just not made clear enough that the canonical place for
SDL documentation is the Doc Wiki at
http://www.libsdl.org/cgi/docwiki.cgi/ (unless I’m mistaken about this
myself…), and AFAIK this is up to date.”

Sorry to disagree, but it is not up to date (at least I couldn’t
find any reference to SDL_GL_ACCELERATED_VISUAL there),

OK, you’re right. In that case, whoever implemented that feature
deserves a smack for not updating the documentation :wink: (that’s what
hopefully will get better with Doxygen). At least it has
SDL_GL_SWAP_CONTROL, which the documentation that ships with the release
doesn’t…

and I think a
Wiki should not be the cannonical place for the documentation (the
files distributed in the official release should).

Well, I’d put it the other way around… the up-to-date files should be
distributed with the official release (whether they come from a wiki or
not). As to whether a wiki is the right place to keep documentation,
this was discussed at length when the wiki was introduced, and judging
from the fact that the wiki exists at all today, I suppose the consensus
must have been that it’s a good thing.

I’m not sure how to make such a snapshot, but as I remember
this to have been one of the primary concerns when the wiki software
was chosen, I suppose it’s possible. In the worst case, use wget.

Sorry to disagree again, but “wget” is not a reasonable choice.

Sure, that’s why I said “in the worst case”. But, just out of curiosity,
what’s so bad about it that warrants putting “not” between asterisks?

Wow, I didn’t even know that DOxygen was being used in 1.3. In fact,
in the time I sent the proposal to the list, I had DOxygen in mind as
one of the tools that would ease my job.

You considered doxygenifying all of SDL’s public headers? Wow, that must
be quite a task. A laudable one, of course, but I’m not sure if it’s
worth the effort now that SDL 1.2 is essentially retired…

-Christian

— Christian Walther escreveu:

“Well, I’d put it the other way around… the up-to-date files should
be distributed with the official release (whether they come from a
wiki or not).”

Agreed.

“As to whether a wiki is the right place to keep documentation, this
was discussed at length when the wiki was introduced, and judging from
the fact that the wiki exists at all today, I suppose the consensus
must have been that it’s a good thing.”

Sorry if I couldn’t express myself accordingly, but what I intended to
say was that users shouldn’t need to recur to the wiki to get complete
and up to date documentation. For dial-up users (like me) that would be
hell.

" =>Sorry to disagree again, but “wget” is not a reasonable choice."
“Sure, that’s why I said “in the worst case”. But, just out of
curiosity, what’s so bad about it that warrants putting “not” between
asterisks?”

Some Unix/Linux users feel comfortable about using “wget”, and almost
every distro I’ve ever used was shipped with it. Windows users, for
example, would have to download WGET, learn how to use it, search for
the wanted help topic and then download it, only to be able to read
something that should be in the ‘docs’ folder.

“You considered doxygenifying all of SDL’s public headers? Wow, that
must be quite a task. A laudable one, of course, but I’m not sure if
it’s worth the effort now that SDL 1.2 is essentially retired…”

You are right, Christian, maybe all my efforts should be focused in
1.3. Sam?_______________________________________________________
Novidade no Yahoo! Mail: receba alertas de novas mensagens no seu celular. Registre seu aparelho agora!
http://br.mobile.yahoo.com/mailalertas/

2006/7/16, Torsten Giebl :
Hello !

FLTK 1.1 used hand written HTML Pages for documentation.
For FLTK 2 they are using Doxygen + HTMLDOC now.

What the future of the Wiki is for SDL-1.3 ?

It will be still usefull for posting code snippets
and example code, maybe when SDL 1.3 is finished we can
come up with something that uses the docum. from the source, maybe plus an ID
for every SDL command and then we can work up some wiki like thing.

I agree. Doxygen-generated docs should go in Wiki and distribution,
but Wiki should be the place for code snippets, tutorials, FAQ etc. +
useul links.–
Roman Kyrylych (??? ???)

Hi, people.

In each frame, I blit aprox. 30 objetcs.
Today I?m bliting that all in a “background” surface (800x600) and, after all, blitting this background in the sfcScreen (sfcScreen = SDL_SetVideoMode) surface.

Wouldn?t be better to blit directly in the sfcScreen surface?
Or is this surface slower than the “ordinary” ones?

And if it?s really slower: why is?

Thanks!---------------------------------
Yahoo! Search
M?sica para ver e ouvir: You’re Beautiful, do James Blunt

Alex (aka Majin) wrote:

— Christian Walther <@Christian_Walther> escreveu:
" =>Sorry to disagree again, but “wget” is not a reasonable choice."
“Sure, that’s why I said “in the worst case”. But, just out of
curiosity, what’s so bad about it that warrants putting “not” between
asterisks?”

Some Unix/Linux users feel comfortable about using “wget”, and almost
every distro I’ve ever used was shipped with it. Windows users, for
example, would have to download WGET, learn how to use it, search for
the wanted help topic and then download it, only to be able to read
something that should be in the ‘docs’ folder.

No, that’s not what I meant. That clearly wouldn’t be very
user-friendly. I meant that Sam (or whoever) could use wget to download
the wiki contents to create the offline-readable documentation that he
would then include with a release.

-Christian