RSS/Atom feed Twitter
Site is read-only, email is disabled

Documenting gegl

This discussion is connected to the gegl-developer-list.gnome.org mailing list which is provided by the GIMP developers and not related to gimpusers.com.

This is a read-only list on gimpusers.com so this discussion thread is read-only, too.

3 of 3 messages available
Toggle history

Please log in to manage your subscriptions.

Documenting gegl Henrik Akesson 19 Feb 18:47
  Documenting gegl Nicolas Robidoux 19 Feb 19:04
  Documenting gegl Martin Nordholts 20 Feb 07:51
Henrik Akesson
2009-02-19 18:47:23 UTC (almost 16 years ago)

Documenting gegl

Hi all,

I'm learning gegl internals for doing some work on parallelizing it (I've posted before on that subject). When I do it I normally write some documentation of my own (when it's missing), such as:

http://computerresearcher.blogspot.com/search/label/Gegl

Note that it's fragmented and still under construction.

Instead of writing it on my blog I could contribute it.

1. Are you interested in that?

If yes:

2. What is the appropriate format. Asciidoc? Note that there are/will be images, documentation for specific c files and general documentation.

3. It would need to be reviewed. I'm after all learning this stuff... How can it be done practically. I suppose that a separate svn branch for me with someone of you merging could be a solution.

/Henrik

Nicolas Robidoux
2009-02-19 19:04:43 UTC (almost 16 years ago)

Documenting gegl

Hello Henrik:

I don't know if this was mentioned before, but the open source VIPS

http://www.vips.ecs.soton.ac.uk/index.php?title=VIPS

although quite different to GEGL, is also somewhat similar.

VIPS handles CMPs well.

Maybe some of VIPS' under the hood parallel machinery would carry over?

Nicolas Robidoux
Laurentian University/Universite Laurentienne

Martin Nordholts
2009-02-20 07:51:12 UTC (almost 16 years ago)

Documenting gegl

Henrik Akesson wrote:

I normally write some documentation of my own (when it's missing) Instead of writing it on my blog I could contribute it.

1. Are you interested in that?

Hi,

Absolutely, and the best way to get the documentation into GEGL is to write patches which add this documentation to the source code. I think the best way for you to do this is to clone the git repository (which is a mirroring of the SVN repository) according to the instructions here:

http://live.gnome.org/GitForGnomeDevelopers

and do your work in git. The workflow on that page is a bit weird but you'll figure out a better one. The only thing that took some time for me to figure out is that when you get error messages when you do a

git svn rebase

that is about non-synced revisions, just do

rm .git/svn/origin/svn/trunk/.rev_map.f648641c-e325-0410-9857-ab48a05b167d

to force a reconstruction of the revision map. When you're done you can just export a patch that you send to the list or attach to bugzilla.

BR, Martin