>       In 'Contributing to Wine' I tried to come up with concrete
> project ideas for contributing to Wine, with special thoughts for
> people new to Wine who might be a bit overwhelmed and not 
> know where to 
> start. I realize this list is not complete (I should try to merge at
> least some of the winehq/projects) and may need adjustments.

You have forgotten one very important point.
"Documentation of the Windows API functions"

This is a huge project that doesn't require any programming
skill at all, eventhough being able to read the C source helps.

An effort to do this was once started by Matt Becker
http://www.glasscity.net/users/mbecker/WineDoc/.
I wonder what happend to him?

In any case I am intrested in restarting the project.
winapi_check currently does rudimentary checks like.
1. Every Windows API function must have a documention header.
2. The documentation header must contain the function name
   in some form.

I have recently submitting some patches doing this.

However, the continuation is more difficult. 
First of all we need some common documentation format.
Matt Becker effort is a good starting point and some
functions already follow this.

Whatever format we decide on I can adapt winapi_check
to check the documentation without much difficulty.
I will probably implement checks for Matt Beckers's
format before long.

However I am not that intresting is actually writing the
documentation but that is something that is suitable for
newbies wanting to help out.

Comments? Suggestions?

Another thing, from the web site:

< Keep track of unimplemented Windows APIs 
< 
< This is yet another variation on Perl and the Windows APIs. This time
< the goal would be to compute the percentage of unimplemented function 
< per library and as a whole. This can be done in two complementary ways.
< First by counting the 'stub' entries in the Wine spec files. But many
< functions are 'implemented' from that point of vue although all they 
< really do is a 'FIXME("(),stub!\n");'. So the second level would be
< to try to detect such cases by performing a crude scan of the C files
< looking for a 'FIXME stub' following shortly the start of such a 
< function. This work might be based on the winapi_check Perl scripts
< which already scan the C files looking for functions declared in the spec
files. 
<
< Required skills:
< Perl, a bit of HTML to present the results 

This is trivial to add to winapi_check.

It is simply a matter of adding something like
        if($statements =~ /FIXME[^;]*stub/s) {
            # Do what?
        }
at the appropriate place.

The question is what should if do with the stubs it finds
and how it should be presented?

>       Which is why I posted this here. I expect to 'announce' this on
> the newsgroup in a little while, probably along with a new version of
> the PrgWin95 tests, but I wanted to post it here first 
> because it seems
> a little bit more private and I want the 'core' developers to get a
> chance to correct any blatant mistake / inappropriate wording / other
> big blunder before it gets too public (to that I expect it to reach
> that many people anyway).

Looks good IMHO.

Reply via email to