mirror of https://github.com/GNOME/gimp.git
82209920a9
Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html |
||
|---|---|---|
| .. | ||
| GIMP3-plug-in-porting-guide | ||
| app | ||
| g-ir-docs | ||
| libgimp | ||
| libgimpbase | ||
| libgimpcolor | ||
| libgimpconfig | ||
| libgimpmath | ||
| libgimpmodule | ||
| libgimpthumb | ||
| libgimpwidgets | ||
| performance-logs | ||
| tools | ||
| .gitignore | ||
| GIMP3-API-Changes.txt | ||
| Jenkins-Tutorial.odt | ||
| Makefile.am | ||
| README | ||
| README.gtkdoc | ||
| c.vim | ||
| commit-rules.txt | ||
| compositing.txt | ||
| contexts.txt | ||
| debug-plug-ins.txt | ||
| debugging-tips.txt | ||
| exif-handling.txt | ||
| gbr.txt | ||
| ggr.txt | ||
| gih.txt | ||
| gimp-module-dependencies.svg | ||
| gitlab-milestones.txt | ||
| gpb.txt | ||
| gtkbuilder-porting-guide.txt | ||
| icons.txt | ||
| includes.txt | ||
| libtool-instructions.txt | ||
| meson.build | ||
| os-support.txt | ||
| parasites.txt | ||
| pat.txt | ||
| release-howto.txt | ||
| release-stats.sh | ||
| structure.xml | ||
| submitting-patches.txt | ||
| tagging.txt | ||
| ui-framework.txt | ||
| undo.txt | ||
| vbr.txt | ||
| version.in | ||
| xcf.txt | ||
README
Developers documentation
------------------------
This directory holds information that you will find useful if you
develop a GIMP plug-in or want to work on the GIMP core.
See https://wiki.gimp.org/index.php/Main_Page for more information.
app - setup for documentation of the GIMP core;
not built by default since it is huge and
only relevant for core developers
libgimp
libgimpbase
libgimpcolor
libgimpconfig
libgimpmath
libgimpmodule
libgimpthumb
libgimpwidgets - complete libgimp documentation generated from
the source; see README.gtkdoc
tools - the source code for tools used to generate
documentation
gitlab-milestones.txt - describes how the GIMP project uses
milestones in the GNOME gitlab issue tracker
commit-rules.txt - describes rules and things to think
about when creating GIMP commits
contexts.txt - describes how GimpContexts are used in GIMP
debug-plug-ins.txt - how to debug GIMP plug-ins
exif-handling.txt - how GIMP should handle EXIF data
includes.txt - the policy for inclusion of header files
parasites.txt - descriptions of known parasites
release-howto.txt - a check-list for doing a GIMP release
submitting-patches.txt - how to submit a patch for GIMP
tagging.txt - how resource tagging in Gimp works
ui-framework.txt - describes how the GIMP UI framework functions and
how it is implemented
undo.txt - description of the undo system
structure.xml - a DocBook article that gives an overview on
the directory structure of the GIMP source tree,
also check out gimp-module-dependencies.svg
gbr.txt - description of the GBR format used to store
pixmap brushes
ggr.txt - description of the GGR format used to store
GIMP gradients
gih.txt - description of the GIH format used to store a
series of pixmap brushes
gpb.txt - OBSOLETE: description of the GPB format for
pixmap brushes
pat.txt - description of the PAT format for patterns
vbr.txt - description of VBR format used for
"generated" brushes
xcf.txt - description of Gimp's XCF format