Skip to content

[Documentation] Update xtokenize-language.adoc - #25977

Merged
davsclaus merged 3 commits into
apache:camel-4.22.xfrom
skin27:patch-23
Sep 1, 2026
Merged

[Documentation] Update xtokenize-language.adoc#25977
davsclaus merged 3 commits into
apache:camel-4.22.xfrom
skin27:patch-23

Conversation

@skin27

@skin27 skin27 commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

This change:

  • Clarifies the distinction between XML Tokenize (xtokenize) and convential Tokenize.
  • Added the needed Maven dependency
  • Added an example

- Clarify distinction between XML tokenize (xtokenize) and convential tokenize.
- Add need Maven dependency
- Add example
@github-actions

Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@davsclaus davsclaus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to clarify the xtokenize vs. tokenize distinction and add a worked example — the motivation and the Java/XML examples are accurate and a real improvement over the previous one-liner. Two things need to be addressed before this can merge:

  1. Catalog mirror not regenerated. Editing components/camel-stax/src/main/docs/xtokenize-language.adoc also requires regenerating and committing the mirrored copy at catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/xtokenize-language.adoc (see this project's documentation conventions). I checked .github/workflows/pr-build-main.yml on this branch: the build step runs ./etc/scripts/regen.sh and then fails if there are any uncommitted changes afterward, so this PR is very likely to fail CI as-is. Running mvn -DskipTests install (or the project's regen script) in components/camel-stax and committing the regenerated catalog file should fix it.
  2. YAML example uses invalid syntax — see inline comment below.

Separately, not a blocker but worth confirming: this PR targets camel-4.22.x directly rather than main. This project's usual flow lands changes on main first and backports to LTS branches afterward, so main and the other maintenance lines (camel-4.18.x, camel-4.14.x) won't pick up this clarification unless it's ported separately. Was that intentional, or would you be open to retargeting/duplicating this against main?

This review does not replace CodeRabbit, Sourcery, SonarCloud, or other specialized review/static-analysis tools.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Comment thread components/camel-stax/src/main/docs/xtokenize-language.adoc Outdated
Co-authored-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus

Copy link
Copy Markdown
Contributor

ah the split doc was wrong, fixing that now

@skin27

skin27 commented Aug 31, 2026

Copy link
Copy Markdown
Contributor Author
  1. YAML example uses invalid syntax — see inline comment below.
    

This example was derived from the split EIP (https://camel.apache.org/components/4.22.x/eips/split-eip.html) so then it's also incorrect on that page.

  1. Separately, not a blocker but worth confirming: this PR targets camel-4.22.x directly rather than main.

That's OK, but I just use the Edit button on the documentation, this automatically takes that branch. I'm kind of expecting that when I'm using the edit button that branch (latest) is automatically selected. I will try to remember next time.

Note that I left the PR open to be edited by the maintainers, so please feel free to change anything, when something is not correct yet.

@davsclaus

Copy link
Copy Markdown
Contributor

There are uncommitted changes
HEAD detached at pull/25977/merge
Changes not staged for commit:
(use "git add ..." to update what will be committed)
(use "git restore ..." to discard changes in working directory)
modified: catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/xtokenize-language.adoc

@davsclaus

Copy link
Copy Markdown
Contributor

you need to make the same change in that other file, or copy it over

@skin27

skin27 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

I add the same changes to the mirrored copy at catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/xtokenize-language.adoc

@davsclaus
davsclaus merged commit 73a1823 into apache:camel-4.22.x Sep 1, 2026
5 checks passed
davsclaus added a commit that referenced this pull request Sep 1, 2026
* Update xtokenize-language.adoc

- Clarify distinction between XML tokenize (xtokenize) and convential tokenize.
- Add need Maven dependency
- Add example

* Apply suggestion from @davsclaus

Co-authored-by: Claus Ibsen <claus.ibsen@gmail.com>

* Update xtokenize-language.adoc

---------

Co-authored-by: Claus Ibsen <claus.ibsen@gmail.com>

@gnodet gnodet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good documentation improvement that adds Maven dependency info, clarifies the xtokenize vs tokenize distinction, and provides working examples in Java, XML, and YAML DSLs. The examples are technically correct and cover all three DSLs well.

Minor nit: there's a trailing whitespace on line 18 of the doc file ("...XML Tokenize: xtokenize "), but this is purely cosmetic and not blocking.

📋 PR Metadata

Aspect Current Suggested
Milestone (none) 4.22.1

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of Guillaume Nodet

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • catalog/camel-catalog
  • components/camel-stax

🔬 Scalpel shadow comparison — Scalpel: 10 tested, 28 compile-only — current: 9 all tested

Maveniverse Scalpel detected 38 affected modules (current approach: 9).

⚠️ Modules only in Scalpel (29)
  • apache-camel
  • camel-allcomponents
  • camel-catalog
  • camel-catalog-console
  • camel-catalog-lucene
  • camel-catalog-maven
  • camel-catalog-suggest
  • camel-componentdsl
  • camel-csimple-maven-plugin
  • camel-endpointdsl
  • camel-endpointdsl-support
  • camel-itest
  • camel-jbang-core
  • camel-jbang-it
  • camel-jbang-main
  • camel-jbang-plugin-edit
  • camel-jbang-plugin-generate
  • camel-jbang-plugin-kubernetes
  • camel-jbang-plugin-test
  • camel-kamelet-main
  • camel-launcher
  • camel-report-maven-plugin
  • camel-route-parser
  • camel-yaml-dsl
  • camel-yaml-dsl-deserializers
  • camel-yaml-dsl-maven-plugin
  • coverage
  • docs
  • dummy-component

Skip-tests mode would test 10 modules (2 direct + 8 downstream), skip tests for 28 (generated code, meta-modules)

Modules Scalpel would test (10)
  • camel-catalog
  • camel-jbang-mcp
  • camel-jbang-plugin-mcp
  • camel-jbang-plugin-route-parser
  • camel-jbang-plugin-tui
  • camel-jbang-plugin-validate
  • camel-launcher-container
  • camel-stax
  • camel-yaml-dsl-validator
  • camel-yaml-dsl-validator-maven-plugin
Modules with tests skipped (28)
  • apache-camel
  • camel-allcomponents
  • camel-catalog-console
  • camel-catalog-lucene
  • camel-catalog-maven
  • camel-catalog-suggest
  • camel-componentdsl
  • camel-csimple-maven-plugin
  • camel-endpointdsl
  • camel-endpointdsl-support
  • camel-itest
  • camel-jbang-core
  • camel-jbang-it
  • camel-jbang-main
  • camel-jbang-plugin-edit
  • camel-jbang-plugin-generate
  • camel-jbang-plugin-kubernetes
  • camel-jbang-plugin-test
  • camel-kamelet-main
  • camel-launcher
  • camel-report-maven-plugin
  • camel-route-parser
  • camel-yaml-dsl
  • camel-yaml-dsl-deserializers
  • camel-yaml-dsl-maven-plugin
  • coverage
  • docs
  • dummy-component

ℹ️ Shadow mode — Scalpel observes but does not affect test execution. Learn more

All tested modules (38 modules)
  • Camel :: All Components Sync point
  • Camel :: Assembly
  • Camel :: Catalog :: CSimple Maven Plugin (deprecated)
  • Camel :: Catalog :: Camel Catalog
  • Camel :: Catalog :: Camel Report Maven Plugin
  • Camel :: Catalog :: Camel Route Parser
  • Camel :: Catalog :: Console
  • Camel :: Catalog :: Dummy Component
  • Camel :: Catalog :: Lucene (deprecated)
  • Camel :: Catalog :: Maven
  • Camel :: Catalog :: Suggest
  • Camel :: Component DSL
  • Camel :: Coverage
  • Camel :: Docs
  • Camel :: Endpoint DSL
  • Camel :: Endpoint DSL :: Support
  • Camel :: Integration Tests
  • Camel :: JBang :: Core
  • Camel :: JBang :: Integration tests
  • Camel :: JBang :: MCP
  • Camel :: JBang :: Main
  • Camel :: JBang :: Plugin :: Edit
  • Camel :: JBang :: Plugin :: Generate
  • Camel :: JBang :: Plugin :: Kubernetes
  • Camel :: JBang :: Plugin :: MCP
  • Camel :: JBang :: Plugin :: Route Parser
  • Camel :: JBang :: Plugin :: TUI
  • Camel :: JBang :: Plugin :: Testing
  • Camel :: JBang :: Plugin :: Validate
  • Camel :: Kamelet Main
  • Camel :: Launcher
  • Camel :: Launcher :: Container
  • Camel :: StAX
  • Camel :: YAML DSL
  • Camel :: YAML DSL :: Deserializers
  • Camel :: YAML DSL :: Maven Plugins
  • Camel :: YAML DSL :: Validator
  • Camel :: YAML DSL :: Validator Maven Plugin

⚙️ View full build and test results

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants