conf: annotate ignores better

rust-bindings/rust/conf/ostree.toml

@@ -1,3 +1,8 @@
+# Legend:
+# - [IGNORE] we don't want to autogenerate this
+# - [MANUAL] we have manual wrappers for this, but would prefer to autogenerate it
+# - [FAIL] this is currently disabled because it generates broken code
+
 [options]
 work_mode = "normal"
 library = "OSTree"
@@ -78,7 +83,7 @@ manual = [
     "GLib.Variant",
     "GLib.VariantType",
 
-    # types implemented by hand
+    # [MANUAL] types implemented by hand
     "OSTree.KernelArgs",
     "OSTree.RepoCheckoutAtOptions",
     "OSTree.RepoCheckoutFilter",
@@ -121,12 +126,12 @@ os_tree = "ostree"
 name = "OSTree.CollectionRef"
 status = "generate"
     [[object.function]]
-    # helper functions for NULL-terminated arrays
+    # [IGNORE] helper functions for NULL-terminated arrays
     pattern = "dupv|freev"
     ignore = true
 
     [[object.function]]
-    # clone() should already be this
+    # [IGNORE] clone() should already be this
     name = "dup"
     ignore = true
 
@@ -134,17 +139,17 @@ status = "generate"
 name = "OSTree.Repo"
 status = "generate"
     [[object.function]]
-    # this one generates a guchar** incorrectly
+    # [FAIL] this one generates a guchar** incorrectly
     name = "write_content_async"
     ignore = true
 
     [[object.function]]
-    # these fail because of issues with arrays of dubious lifetimes
+    # [FAIL] these fail because of issues with arrays of dubious lifetimes
     pattern = "find_remotes_async|pull_from_remotes_async"
     ignore = true
 
     [[object.function]]
-    # this is deprecated and supposedly unsafe for GI
+    # [IGNORE] this is deprecated and supposedly unsafe for GI
     name = "checkout_tree_at"
     ignore = true
 
@@ -161,7 +166,7 @@ status = "generate"
 name = "OSTree.RepoFinder"
 status = "generate"
     [[object.function]]
-    # these fail because of issues with arrays of dubious lifetimes
+    # [FAIL] these fail because of issues with arrays of dubious lifetimes/NULL-terminated arrays
     pattern = "resolve_async|resolve_all_async"
     ignore = true
 
@@ -169,12 +174,12 @@ status = "generate"
 name = "OSTree.RepoFinderResult"
 status = "generate"
     [[object.function]]
-    # array helper function
+    # [IGNORE] array helper function
     name = "freev"
     ignore = true
 
     [[object.function]]
-    # clone() should already be this
+    # [IGNORE] clone() should already be this
     name = "dup"
     ignore = true
 
@@ -188,7 +193,7 @@ clear_function_expression = "|_ptr| ()"
 name = "OSTree.SePolicy"
 status = "generate"
     [[object.function]]
-    # has an unused raw pointer parameter so we wrap it by hand
+    # [IGNORE] has an unused raw pointer parameter
     name = "fscreatecon_cleanup"
     ignore = true
 
@@ -196,6 +201,7 @@ status = "generate"
 name = "OSTree.Sign"
 status = "generate"
     [[object.function]]
+    # [IGNORE] these shouldn't be on this type, they belong to subclasses
     pattern = "dummy_.+|ed25519_.+"
     ignore = true
 
@@ -212,21 +218,31 @@ status = "generate"
 name = "OSTree.*"
 status = "generate"
     [[object.function]]
-    # low-level functions with unsafe APIs
-    pattern = "cmp_checksum_bytes|checksum_inplace_from_bytes|checksum_inplace_to_bytes|checksum_b64_inplace_from_bytes|checksum_b64_inplace_to_bytes|hash_object_name"
+    # [MANUAL] probably can't be autogenerated because of the custom Checksum type
+    pattern = "checksum_file|checksum_file_async|checksum_file_at|checksum_file_from_input"
     ignore = true
 
     [[object.function]]
-    # private API
+    # [IGNORE] low-level checksum functions, we have a custom checksum API
+    pattern = "cmp_checksum_bytes|checksum_from_bytes|checksum_to_bytes|checksum_inplace_from_bytes|checksum_inplace_to_bytes|checksum_b64_from_bytes|checksum_b64_to_bytes|checksum_b64_inplace_from_bytes|checksum_b64_inplace_to_bytes"
+    ignore = true
+
+    [[object.function]]
+    # [IGNORE] needs custom handling to deal with its raw pointer parameter
+    pattern = "hash_object_name"
+    ignore = true
+
+    [[object.function]]
+    # [IGNORE] private API
     pattern = "cmd__private__"
     ignore = true
 
     [[object.constant]]
-    # version-dependent constants
+    # [IGNORE] version-dependent constants
     pattern = "VERSION|VERSION_S|YEAR_VERSION|RELEASE_VERSION"
     ignore = true
 
     [[object.constant]]
-    # build-dependent constants
+    # [IGNORE] build-dependent constants
     pattern = "BUILT_FEATURES"
     ignore = true