(paimon) branch master updated: [doc] Exclude deprecated `branch` option (#5460)

[lzljs3620320]

This is an automated email from the ASF dual-hosted git repository.

lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/paimon.git


The following commit(s) were added to refs/heads/master by this push:
     new 97c874a5b0 [doc] Exclude deprecated `branch` option (#5460)
97c874a5b0 is described below

commit 97c874a5b0bbf59b095308b7fbf5e33a59353f1d
Author: Yubin Li <lixin58...@163.com>
AuthorDate: Tue Apr 15 15:05:01 2025 +0800

    [doc] Exclude deprecated `branch` option (#5460)
---
 docs/layouts/shortcodes/generated/core_configuration.html      | 6 ------
 paimon-common/src/main/java/org/apache/paimon/CoreOptions.java | 1 +
 2 files changed, 1 insertion(+), 6 deletions(-)

diff --git a/docs/layouts/shortcodes/generated/core_configuration.html 
b/docs/layouts/shortcodes/generated/core_configuration.html
index b490859717..ae6fded4f8 100644
--- a/docs/layouts/shortcodes/generated/core_configuration.html
+++ b/docs/layouts/shortcodes/generated/core_configuration.html
@@ -44,12 +44,6 @@ under the License.
             <td>Boolean</td>
             <td>Whether to create underlying storage when reading and writing 
the table.</td>
         </tr>
-        <tr>
-            <td><h5>branch</h5></td>
-            <td style="word-wrap: break-word;">"main"</td>
-            <td>String</td>
-            <td>Specify branch name.</td>
-        </tr>
         <tr>
             <td><h5>bucket</h5></td>
             <td style="word-wrap: break-word;">-1</td>
diff --git a/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java 
b/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
index cf5b417cdf..33fc36ee9d 100644
--- a/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
+++ b/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
@@ -160,6 +160,7 @@ public class CoreOptions implements Serializable {
                     .noDefaultValue()
                     .withDescription("The file path of this table in the 
filesystem.");
 
+    @ExcludeFromDocumentation("Avoid using deprecated options")
     public static final ConfigOption<String> BRANCH =
             
key("branch").stringType().defaultValue("main").withDescription("Specify branch 
name.");