Release doc tasks
Dan Sugalski
really cool. Things are looking good. There are, however, some big
doc jobs that need tackling, and I'd like to get someone (or several
someones) to dig into them.
I'm working on PDD 15, which should be done soon, and I'll give PDD 3
another going-over to make sure it's right. The rest of the PDDs need
a look-over to see where they fall down. (Several are pretty out of
date, and others (like the NCI one) need more work)
We need to get the IMCC /PIR docs significantly beefed up, so someone
can take a look at things and actually generate code without too much
head-scratching.
The stuff in the docs/ directory needs looking over to see where
things are out of date or need thumping.
If someone wants to put together a skeleton plan for docs that really
ought be in the tarball, we can use that to start filling in docs.
And if everyone'd take a look at the intro docs to see where they
need fixing, that'd be really great too.
--
Dan
--------------------------------------"it's like this"-------------------
Dan Sugalski even samurai
d...@sidhe.org have teddy bears and even
teddy bears get drunk
Simon Glover
Re. obsolete docs:
parrot_assembly.pod is a really old version of pdd06, and should
probably just be dumped (the last patch to it was 16 months ago, the
last non-trivial patch about 2 years ago)
embed.pod should probably be reworked as a proper PDD (since
pdd10_embedding.pod is empty right now)
pdd12_assembly.pod -- what was the intent of this? (i.e. is there stuff
that isn't covered in pdd06_pasm.pod that should go in here, or can
we just dump this and recycle the number?)
Simon
Michael Scott
On 19 Feb 2004, at 20:59, Simon Glover wrote:
> pdd12_assembly.pod -- what was the intent of this? (i.e. is there
> stuff
> that isn't covered in pdd06_pasm.pod that should go in here, or can
> we just dump this and recycle the number?)
Yes it should go. It's just an earlier version of pdd06.
I'm almost done with the PMCs, though what I'm doing is fairly minimal.
I've had to take a sort of head-down approach to working on the docs.
Building inline stuff up to a certain level, before moving on to
integration and coherence (will not be for this release).
What I do hope to achieve for the "Extra Day" release is to get
hyperlinks working for the html docs. I'll work on that this weekend.
Once that's done I'll join in the get-it-up-to-date frenzy.
One thing that would help is if people ran
perl tools/docs/write_docs.pl -d -s
on various platforms and told me if it works - or what they did to make
it work - because I only have access to Mac OS X 10.3.2 here. Run it
after running make, because it will die looking for docs/packfile-c.pod
otherwise.
BTW on a personal note, my CFT expires on the 1st May - back to a job
in London - so in my head that's deadline I'm working towards. I want
to have a decent documentation system set up by then.
Mike
Chromatic
> One thing that would help is if people ran
>
> perl tools/docs/write_docs.pl -d -s
>
> on various platforms and told me if it works - or what they did to make
> it work - because I only have access to Mac OS X 10.3.2 here.
It choked here on Linux with "Failed to process lib/Parrot/Pmc.pm".
<teasing>Modern filesystems understand both upper and lower
case.</teasing>
With the applied patch, there's only one warning:
Use of uninitialized value in substitution (s///) at
lib/Pod/Simple/HTML.pm line 344.
-- c
Michael Scott
On 20 Feb 2004, at 01:56, chromatic wrote:
> On Thu, 2004-02-19 at 16:34, Michael Scott wrote:
>
>> One thing that would help is if people ran
>>
>> perl tools/docs/write_docs.pl -d -s
>>
>> on various platforms and told me if it works - or what they did to
>> make
>> it work - because I only have access to Mac OS X 10.3.2 here.
>
> It choked here on Linux with "Failed to process lib/Parrot/Pmc.pm".
>
> <teasing>Modern filesystems understand both upper and lower
> case.</teasing>
Embarrassing isn't it. System Preferences needs a "strict" button.
>
> With the applied patch, there's only one warning:
>
> Use of uninitialized value in substitution (s///) at
> lib/Pod/Simple/HTML.pm line 344.
Yep, this one is a trivial thing that will get squashed this weekend.
>
> -- c
>
>
> <write_docs.patch>
Dan Sugalski
>On Thu, 2004-02-19 at 16:34, Michael Scott wrote:
>
>> One thing that would help is if people ran
>>
>> perl tools/docs/write_docs.pl -d -s
>>
>> on various platforms and told me if it works - or what they did to make
>> it work - because I only have access to Mac OS X 10.3.2 here.
>
>It choked here on Linux with "Failed to process lib/Parrot/Pmc.pm".
>
><teasing>Modern filesystems understand both upper and lower
>case.</teasing>
Nah. Modern filesystems understand that A and a are the same letter.
It's those old antique filesystems that don't understand that... :-P
Leopold Toetsch
> Nah. Modern filesystems understand that A and a are the same letter.
> It's those old antique filesystems that don't understand that... :-P
yeP dAn, yOu ArE rIghT.
leO, sCnr
Jerry Gay
>
> perl tools/docs/write_docs.pl -d -s
>
> on various platforms and told me if it works - or what they
runs fine on Windows 2000, with only the warning mentioned by chromatic.
**************************************************************************
This e-mail and any files transmitted with it may contain privileged or
confidential information. It is solely for use by the individual for whom
it is intended, even if addressed incorrectly. If you received this e-mail
in error, please notify the sender; do not disclose, copy, distribute, or
take any action in reliance on the contents of this information; and delete
it from your system. Any other use of this e-mail is prohibited. Thank you
for your compliance.
Piers Cawley
Paul Cochrane
Runs fine on my box:
interactionmac parrot $ uname -a
Linux interactionmac.physics.uq.edu.au 2.4.19-r6 #7 Tue Apr 22 16:54:53 EST
2003 ppc 740/750 GNU/Linux
interactionmac parrot $ perl -v
This is perl, v5.8.0 built for powerpc-linux
Copyright 1987-2002, Larry Wall
Perl may be copied only under the terms of either the Artistic License or the
GNU General Public License, which may be found in the Perl 5 source kit.
Complete documentation for Perl, including FAQ lists, should be found on
this system using `man perl' or `perldoc perl'. If you have access to the
Internet, point your browser at http://www.perl.com/, the Perl Home Page.
Later
Paul
--
coch...@physics.uq.edu.au
Department of Physics
University of Queensland
St Lucia
Brisbane
Queensland 4072
Australia
Quantum Mechanics: the dreams stuff is made of.