doc(toolchain): sync tools with master - #475
Open
bitflicker64 wants to merge 1 commit into
Open
Conversation
Bring the hugegraph-tools pages (en and cn) back in line with the CLI on toolchain master: drop the unregistered --protocol global, add --throw-mode, fix the graph-create/graph-clone, --log, dump and auth directory defaults, add the missing --thread-num option and the 'schema' type, drop --log and --thread-num from the auth commands where they do not exist, document the timeout floors and the schedule-backup, deploy and clear behaviour, and refresh the usage block with the commands and text it was missing. Also correct the graph modes and default url in the backup/restore guide.
imbajin
reviewed
Sep 6, 2026
imbajin
left a comment
imbajin
left a comment
Member
There was a problem hiding this comment.
Blocking: no. Summary: The deploy documentation advertises a default download prefix that does not resolve to a published server release. Evidence: verified against the exact-head docs, deploy.sh URL construction, version-map.yaml, and GitHub release metadata.
| > There is an optional parameter -u in the deploy command. When provided, the specified download address will be used instead of the default download address to download the tar package, and the address will be written into the `~/hugegraph-download-url-prefix` file; if no address is specified later When -u and `~/hugegraph-download-url-prefix` are not specified, the tar package will be downloaded from the address specified by `~/hugegraph-download-url-prefix`; if there is neither -u nor `~/hugegraph-download-url-prefix`, it will be downloaded from the default download address | ||
| > deploy, start-all, clear and stop-all are handed by `bin/hugegraph` straight to the shell scripts `bin/deploy.sh`, `bin/start-all.sh`, `bin/clear.sh` and `bin/stop-all.sh`, so the global options and environment variables in 3.2 do not apply to them. | ||
|
|
||
| > There is an optional parameter -u in the deploy command. When provided, the specified download address will be used instead of the default download address to download the tar package, and the address will be written into the `~/hugegraph-download-url-prefix` file; if no address is specified later When -u and `~/hugegraph-download-url-prefix` are not specified, the tar package will be downloaded from the address specified by `~/hugegraph-download-url-prefix`; if there is neither -u nor `~/hugegraph-download-url-prefix`, it will be downloaded from the default download address `https://github.com/hugegraph` |
Member
There was a problem hiding this comment.
deploy. deploy.sh combines it with /hugegraph/releases/download/v${SERVER_VERSION}/...; for -v 0.8 that resolves to https://github.com/hugegraph/hugegraph/releases/download/v0.8.0/hugegraph-0.8.0.tar.gz, but that release is not published there. Please fix the script or document a verified download prefix/URL before advertising this default, and mirror the correction in the Chinese page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of the PR
Sync the hugegraph-tools docs (en + cn) with hugegraph-toolchain master (3b385c3d).
The pages had drifted from the CLI: they documented a global option that is not registered, missed one global option and several sub-command options, listed options on the auth commands that do not exist there, and carried several wrong defaults. The usage block was also missing three graph sub-commands and both auth sub-commands.
--protocollisted as a global option, but it is never registered on the main command--urlscheme--throw-modeglobal option not documentedfalsedefault--trust-store-file/--trust-store-passwordhad no stated constraint;--user/--passwordpairing not stated--url, and that user and password must both be set or both omittedJAVA_HOMEandJAVA_OPTIONSnot mentioned-Xmx--namedefault given ashugegraph, and--filemarked requiredg;--fileis optional and its content is sent as the graph config--namedefault given ashugegraph, and--clone-graph-namemissingg; added--clone-graph-namewith defaulthugegraph--timeoutto at least 300 seconds--statushad no value list;--limithad no positivity note; task-cancel--task-idnot marked required--huge-typeslist omitted theschemavalueschemaand what it expands to for backup, restore and migrate--logdefault given as the current directory./logs--thread-num/-Tmissing from backup, restore, migrate and dumpMath.min(10, Math.max(4, CPUs / 2))default--split-sizehad no minimum--labeldescribed only as applying to vertex/edge backups--huge-typesmust name exactly one type, vertex or edge--timeoutbelow 120 seconds is raised to 120 for backup and for the backup step of migrate--graph-modehad no default and no note about the mode swap--intervalhad no default, and the crontab behaviour was undocumented"0 0 * * *"default plus a note on the crontab entry, the backup path, the retention and the relative-path rule--directorydefault given as the current directory./{graphName}locally and{fs.default.name}/{graphName}on HDFS--logand--thread-num, which they do not accept, and gave-das a short form of--directory-dshort form; corrected the directory default to./auth-backup-restore--typesdid not state the belong/access dependencies;--init-passwordcondition was vague--typescontaininguser-vhad no value list; clear did not describe its guards; the default download prefix was not namedhugegraph-tools-${version}.tar.gz, and the release-package layout was not givenapache-hugegraph-tools-${version}.tar.gzplus the unpacked directory, and added the path to the tools directory inside the toolchain packagehttp://127.0.0.1http://127.0.0.1:8080, the actual--urldefaultScope note: only the hugegraph-tools parts of the backup/restore guide were touched.
Paths in the "Source on master" column are relative to
hugegraph-tools/unless stated otherwise.