Lots of module READMEs; libs-core, libs-gui, components, filter, base, calc

2012-02-08 Thread Michael Meeks
Hi Josh,

On Wed, 2012-02-08 at 17:24 +1030, Josh Heidenreich wrote:
 Cool so I'm re-running the tool again at the moment, but it will be
 done in a couple of minutes.

Nice work :-)

 You can see the result here:
 http://thejosh.info/libreoffice/module_readmes/

Looks lovely; incidentally - if you parse the first line of the
*/prj/build.lst files - it gives you a dependency list of the modules
that are required by this module :-) [ though that may go obsolete in
the next year or so ]. Might be interesting to provide to give a flavour
of whether a package is a leaf-node ? etc.

I really like the links to cgit, it starts to make it rather nicely
integrated :-) It makes me wonder if we should have some nice syntax for
cross-module linking (or simplified file path links that can be turned
into cgit URLs) in the README's themselves ;-) [ if it's not broken, it
doesn't have enough features yet ].

As another wish - I wonder if we can link modules into the
http://docs.libreoffice.org/ doxygen documentation (that is if they have
any) - and assuming that is even the up-to-date place to find things :-)

Anyhow, you inspired me to add and expand a few more READMEs myself,
hope that helps a bit.

I imagine that a lot of the 'libfoo' things missing READMEs, can be
populated with information from the download pages, and a quick grep of
*/prj/build.lst to see which modules use them. There was also some
one-liner descriptions of some of that stuff here:

http://www.openoffice.org/external/

in the past :-)

Really encouraged by your work, good stuff,

Thanks !

Michael.

-- 
michael.me...@suse.com  , Pseudo Engineer, itinerant idiot

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice


Re: Lots of module READMEs; libs-core, libs-gui, components, filter, base, calc

2012-02-08 Thread Thorsten Behrens
Michael Meeks wrote:
   As another wish - I wonder if we can link modules into the
 http://docs.libreoffice.org/ doxygen documentation (that is if they have
 any) - and assuming that is even the up-to-date place to find things :-)
 
The script that generates that load is solenv/bin/mkdocs.sh - would
be lovely to have that integrated, yeps.

Cheers,

-- Thorsten


pgpAgLiCXZeAy.pgp
Description: PGP signature
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice


[PATCH] Lots of module READMEs; libs-core, libs-gui, components, filter, base, calc

2012-02-07 Thread Josh Heidenreich
Hi,

As per my module README porting from wiki and improving project, here
are some more patches which add more READMEs.

I sent an email yesterday, which seems to be missed, so I have
included that patch again.

I also did a heap more READMEs, thus why there is five patches instead
of just one. It's one commit per old-repository, so all of the modules
which used to be in libs-core are in a single patch. Same with
libs-gui, components, filter, although base and calc are in the same
patch.

Cheers,
Josh


0001-Added-READMEs-for-modules-which-used-to-be-in-libs-c.patch
Description: Binary data


0002-Added-and-improved-READMEs-for-modules-which-used-to.patch
Description: Binary data


0003-Added-READMEs-for-modules-which-used-to-be-in-compon.patch
Description: Binary data


0004-Added-and-improved-READMEs-for-modules-which-used-to.patch
Description: Binary data


0005-Added-READMEs-for-modules-used-by-LibO-Base-and-LibO.patch
Description: Binary data
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice


Re: [PATCH] Lots of module READMEs; libs-core, libs-gui, components, filter, base, calc

2012-02-07 Thread Josh Heidenreich
Update:
David just pushed
0001-Added-READMEs-for-modules-which-used-to-be-in-libs-c.patch, so
don't push it again!



On Wed, Feb 8, 2012 at 12:30 PM, Josh Heidenreich
josh.sickm...@gmail.com wrote:
 Hi,

 As per my module README porting from wiki and improving project, here
 are some more patches which add more READMEs.

 I sent an email yesterday, which seems to be missed, so I have
 included that patch again.

 I also did a heap more READMEs, thus why there is five patches instead
 of just one. It's one commit per old-repository, so all of the modules
 which used to be in libs-core are in a single patch. Same with
 libs-gui, components, filter, although base and calc are in the same
 patch.

 Cheers,
 Josh
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice


Re: [PATCH] [PUSHED] Lots of module READMEs; libs-core, libs-gui, components, filter, base, calc

2012-02-07 Thread David Tardon
On Wed, Feb 08, 2012 at 12:30:11PM +1030, Josh Heidenreich wrote:
 Hi,
 
 As per my module README porting from wiki and improving project, here
 are some more patches which add more READMEs.

And I just pushed the whole lot of it.

 
 I sent an email yesterday, which seems to be missed, so I have
 included that patch again.

You should allow us some slack in processing patches .-)

D.
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice


Re: [PATCH] [PUSHED] Lots of module READMEs; libs-core, libs-gui, components, filter, base, calc

2012-02-07 Thread Josh Heidenreich
David,

 And I just pushed the whole lot of it.
Sweeet.

Cool so I'm re-running the tool again at the moment, but it will be
done in a couple of minutes.

You can see the result here:
http://thejosh.info/libreoffice/module_readmes/

Cheers,
Josh
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice