Skip to content

docs: explain loader argument files - #518

Open
imbajin wants to merge 2 commits into
apache:masterfrom
hugegraph:fix/doc-loader-argument-files
Open

imbajin wants to merge 2 commits into
apache:masterfrom
hugegraph:fix/doc-loader-argument-files

Conversation

@imbajin

@imbajin imbajin commented Oct 12, 2026

Copy link
Copy Markdown
Member

The Loader guide rejected commands with fewer than three arguments, contradicting the corrected mapping-only and native JCommander argument-file behavior. The English and Chinese guides now show equivalent --file struct.json and @loader.args calls, relative-path handling, credential-file permissions and writable progress directories.

Paired code fix: ASF toolchain #808, from the same source branch validated in org #61. Coordinate the code and website merges.

Validation: complete source link checks, strict Hugo production build, fresh bilingual HTML checks and independent document review passed. CI helpers and locked theme files are unchanged from the published cold-cache fix. The same documentation branch passed the selected org site build and browser validation before submission here.

- replace the obsolete raw argument-count rule
- document minimal mapping and response-file calls
- clarify relative paths and credential file permissions
- explain writable progress directories in both languages

@bitflicker64 bitflicker64 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.

Blocking: no. Summary: The argument-file section matches the merged loader change (apache/hugegraph-toolchain#808) and the English and Chinese pages agree; the only issue is that the reworded progress-file note overstates when a progress file is written on master. Evidence: static read of LoadOptions.parseOptions, LoadContext.close, LoadProgress, LoadUtil.getStructDirPrefix, LoadOptionsTest and bin/hugegraph-loader.sh at toolchain master 2692b6bf, JCommander 1.78 readFile bytecode (one argument per non-empty, non-# line), and the full diff of both pages at 65e9719.

Comment thread content/en/docs/quickstart/toolchain/hugegraph-loader.md Outdated
- limit progress writes to normal completion
- explain the unexpected failure boundary
- align both language versions with loader behavior

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants