chore: deprecate native_comet scan in favor of native_iceberg_compat

[Shekharrajak]

Add deprecation annotation to SCAN_NATIVE_COMET and update documentation to recommend native_iceberg_compat. The legacy scan uses mutable buffers incompatible with Arrow FFI best practices.

Ref #2949

[coderfender]

@Shekharrajak , please run make format to format the code and that should pass the builds

[Shekharrajak]

@Shekharrajak , please run make format to format the code and that should pass the builds

This is done already.

[coderfender]

@Shekharrajak , seems like the formatting is still an issue ?

error file=/__w/datafusion-comet/datafusion-comet/common/src/main/scala/org/apache/comet/CometConf.scala message=File line length exceeds 100 characters line=128
error file=/__w/datafusion-comet/datafusion-comet/common/src/main/scala/org/apache/comet/CometConf.scala message=File line length exceeds 100 characters line=130
error file=/__w/datafusion-comet/datafusion-comet/common/src/main/scala/org/apache/comet/CometConf.scala message=File line length exceeds 100 characters line=131
error file=/__w/datafusion-comet/datafusion-comet/common/src/main/scala/org/apache/comet/CometConf.scala message=File line length exceeds 100 characters line=132

[coderfender]

@Shekharrajak could also please link the issue you are closing so that there is no duplicate work associated?

[Shekharrajak]

Ref #2949

comment native_iceberg_compat

[coderfender]

Thank you