Updating the on-line documentation

Updating the on-line documentation

[John Dallaway]

eCos maintainers

We should update the documentation at:

  http://ecos.sourceware.org/docs-latest/

Does someone have a script to do this?

John Dallaway

Re: Updating the on-line documentation

[Andrew Lunn]

On Sun, Feb 22, 2009 at 09:30:11AM +0000, John Dallaway wrote:
> eCos maintainers
> 
> We should update the documentation at:
> 
>   http://ecos.sourceware.org/docs-latest/
> 
> Does someone have a script to do this?

I've always done it manually. 

A script would be nice.

  Andrew

Re: Updating the on-line documentation

[Jonathan Larmour]

Andrew Lunn wrote:
> On Sun, Feb 22, 2009 at 09:30:11AM +0000, John Dallaway wrote:
> 
>>eCos maintainers
>>
>>We should update the documentation at:
>>
>>  http://ecos.sourceware.org/docs-latest/
>>
>>Does someone have a script to do this?

Note that it was updated at end of November, so it's not very out-of-date.

> I've always done it manually. 
> 
> A script would be nice.

I've done it manually too. Judicious use of "cvs -qn up | grep '?'" can be 
useful.

Jifl
-- 
*See us at Embedded World 2009, Nürnberg, Germany, 3-5 Mar, Stand 11-300*
eCosCentric Limited      http://www.eCosCentric.com/     The eCos experts
Barnwell House, Barnwell Drive, Cambridge, UK.       Tel: +44 1223 245571
Registered in England and Wales: Reg No 4422071.
------["Si fractum non sit, noli id reficere"]------       Opinions==mine

Re: Updating the on-line documentation

[John Dallaway]

Hi Jifl

Jonathan Larmour wrote:

> Andrew Lunn wrote:
>> On Sun, Feb 22, 2009 at 09:30:11AM +0000, John Dallaway wrote:
>>
>>> eCos maintainers
>>>
>>> We should update the documentation at:
>>>
>>>  http://ecos.sourceware.org/docs-latest/
>>>
>>> Does someone have a script to do this?
> 
> Note that it was updated at end of November, so it's not very out-of-date.

Unfortunately, this was preceding the documentation copyright notice
changes and the ColdFire docs were missing from the doclist file at the
time:

> [jld@cog sgml]$ cvs diff -u0 -r 1.25 doclist 
> Index: doclist
> ===================================================================
> RCS file: /cvs/ecos/ecos/doc/sgml/doclist,v
> retrieving revision 1.25
> retrieving revision 1.27
> diff -u -0 -r1.25 -r1.27
> --- doclist     18 Nov 2008 01:28:11 -0000      1.25
> +++ doclist     10 Dec 2008 09:55:08 -0000      1.27
> @@ -43,0 +44,5 @@
> +hal/m68k/arch/current/doc/m68k.sgml
> +hal/m68k/mcf52xx/var/current/doc/mcf52xx.sgml
> +hal/m68k/mcf52xx/mcf5272/proc/current/doc/mcf5272.sgml
> +hal/m68k/mcf52xx/mcf5272/m5272c3/current/doc/m5272c3.sgml
> +hal/sh/sh4_202_md/current/doc/sh4_202_md.sgml
> @@ -46,0 +52,2 @@
> +devs/eth/m68k/mcf5272/current/doc/mcf5272_eth.sgml
> +devs/serial/m68k/mcf52xx/current/doc/mcf52xx_ser.sgml
> @@ -52,0 +60 @@
> +devs/i2c/m68k/mcf52xx/current/doc/mcf52xx_i2c.sgml
> [jld@cog sgml]$ 

Updating the on-line docs could wait until the 3.0 final release, but I
was thinking people would be more likely to be trawling over the docs
during the beta period. I may take a look at updating them if I get a
spare moment...

John Dallaway

Re: Updating the on-line documentation

[Jonathan Larmour]

John Dallaway wrote:
> 
> Updating the on-line docs could wait until the 3.0 final release, but I
> was thinking people would be more likely to be trawling over the docs
> during the beta period. I may take a look at updating them if I get a
> spare moment...

I knew it wouldn't take me long, so I've done it. For future ref, these 
are roughly the sort-of commands which make things a lot easier 
(substitute docsbuild where appropriate e.g. ~/ecos/trunk/doc/sgml/):

cd ecos/trunk/htdocs/docs-latest/something
rm *.html *.png
cp /docsbuild/*.html .
cp /docsbuild/*.png .
cvs -qn up | egrep ^\\? | awk '{print $2}' | xargs cvs add
cvs -qn up | egrep ^U | awk '{print $2}' | xargs cvs rm
cvs ci -m "Update docs to latest CVS"

Repeat for redboot, user-guide, cdl-guide.

Jifl
-- 
*See us at Embedded World 2009, Nürnberg, Germany, 3-5 Mar, Stand 11-300*
eCosCentric Limited      http://www.eCosCentric.com/     The eCos experts
Barnwell House, Barnwell Drive, Cambridge, UK.       Tel: +44 1223 245571
Registered in England and Wales: Reg No 4422071.
------["Si fractum non sit, noli id reficere"]------       Opinions==mine