From 313445b4cf3e58e1bd1a3acc855c8ca1450a4473 Mon Sep 17 00:00:00 2001 From: Jehan Date: Fri, 24 Oct 2025 02:56:08 +0200 Subject: [PATCH] app, libgimp, pdb: fix docs of gimp_file_load() and gimp_image_is_dirty(). See commit 822c26f709. We decided to solve #14463 by having gimp_file_load() always force-clean the image and reset the undo stack. Therefore fix the docs again. --- app/pdb/file-cmds.c | 2 +- app/pdb/image-cmds.c | 4 +++- libgimp/gimpfile_pdb.c | 3 +-- libgimp/gimpimage_pdb.c | 7 +++++-- pdb/groups/file.pdb | 3 +-- pdb/groups/image.pdb | 8 ++++++-- 6 files changed, 17 insertions(+), 10 deletions(-) diff --git a/app/pdb/file-cmds.c b/app/pdb/file-cmds.c index 8774fa5e67..366484f452 100644 --- a/app/pdb/file-cmds.c +++ b/app/pdb/file-cmds.c @@ -419,7 +419,7 @@ register_file_procs (GimpPDB *pdb) "gimp-file-load"); gimp_procedure_set_static_help (procedure, "Loads an image file by invoking the right load handler.", - "This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not. Note that the loaded image will be marked as dirty, which can be changed by calling [method@Gimp.Image.clean_all].", + "This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not. Note that the loaded image will be marked as clean.", NULL); gimp_procedure_set_static_attribution (procedure, "Josh MacDonald", diff --git a/app/pdb/image-cmds.c b/app/pdb/image-cmds.c index 0ed2337393..4270b2d4a2 100644 --- a/app/pdb/image-cmds.c +++ b/app/pdb/image-cmds.c @@ -4658,7 +4658,9 @@ register_image_procs (GimpPDB *pdb) "gimp-image-is-dirty"); gimp_procedure_set_static_help (procedure, "Checks if the image has unsaved changes.", - "This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after calling a save procedure to make the image clean. When loading an image using e.g. [func@Gimp.file_load] the image will be marked as dirty too.", + "This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after calling a save procedure to make the image clean.\n" + "\n" + "When loading an image using e.g. [func@Gimp.file_load] the image will be marked as clean, but loading an image calling directly the accurate file format procedure may return a dirty image.", NULL); gimp_procedure_set_static_attribution (procedure, "Spencer Kimball & Peter Mattis", diff --git a/libgimp/gimpfile_pdb.c b/libgimp/gimpfile_pdb.c index 2f580a4ef4..231802066b 100644 --- a/libgimp/gimpfile_pdb.c +++ b/libgimp/gimpfile_pdb.c @@ -45,8 +45,7 @@ * * This procedure invokes the correct file load handler using magic if * possible, and falling back on the file's extension and/or prefix if - * not. Note that the loaded image will be marked as dirty, which can - * be changed by calling [method@Gimp.Image.clean_all]. + * not. Note that the loaded image will be marked as clean. * * Returns: (transfer none): The output image. **/ diff --git a/libgimp/gimpimage_pdb.c b/libgimp/gimpimage_pdb.c index 50dc53bf3b..486a97a81a 100644 --- a/libgimp/gimpimage_pdb.c +++ b/libgimp/gimpimage_pdb.c @@ -2084,8 +2084,11 @@ gimp_image_clean_all (GimpImage *image) * needs to be saved. Note that saving the image does not automatically * set the dirty count to 0, you need to call * [method@Gimp.Image.clean_all] after calling a save procedure to make - * the image clean. When loading an image using e.g. - * [func@Gimp.file_load] the image will be marked as dirty too. + * the image clean. + * + * When loading an image using e.g. [func@Gimp.file_load] the image + * will be marked as clean, but loading an image calling directly the + * accurate file format procedure may return a dirty image. * * Returns: TRUE if the image has unsaved changes. **/ diff --git a/pdb/groups/file.pdb b/pdb/groups/file.pdb index f3117be060..695b9daead 100644 --- a/pdb/groups/file.pdb +++ b/pdb/groups/file.pdb @@ -23,8 +23,7 @@ sub file_load { $help = <<'HELP'; This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if -not. Note that the loaded image will be marked as dirty, which can be -changed by calling [method@Gimp.Image.clean_all]. +not. Note that the loaded image will be marked as clean. HELP &josh_pdb_misc('1997'); diff --git a/pdb/groups/image.pdb b/pdb/groups/image.pdb index b6bacfe2bf..d5bdc02f98 100644 --- a/pdb/groups/image.pdb +++ b/pdb/groups/image.pdb @@ -1796,8 +1796,12 @@ sub image_is_dirty { This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call [method@Gimp.Image.clean_all] after -calling a save procedure to make the image clean. When loading an image using -e.g. [func@Gimp.file_load] the image will be marked as dirty too. +calling a save procedure to make the image clean. + + +When loading an image using e.g. [func@Gimp.file_load] the image will be +marked as clean, but loading an image calling directly the accurate file +format procedure may return a dirty image. HELP &std_pdb_misc;