You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues-all@impala.apache.org by "Noemi Pap-Takacs (Jira)" <ji...@apache.org> on 2024/09/23 15:25:00 UTC
[jira] [Commented] (IMPALA-8009) Generate documentation for all command line flags
[ https://issues.apache.org/jira/browse/IMPALA-8009?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17883915#comment-17883915 ]
Noemi Pap-Takacs commented on IMPALA-8009:
------------------------------------------
All global/startup flags are listed under '/varz' on the WebUI with their description, default and current values (see IMPALA-3972). This fact is documented in 'impala_config_options'. It is a similar solution to the documentation of query profile fields that are listed under '/profile_docs' (resolved in IMPALA-7550).
However, in both cases the user needs a running impala cluster to display the docs. We need to generate an XML to build the docs independently.
> Generate documentation for all command line flags
> -------------------------------------------------
>
> Key: IMPALA-8009
> URL: https://issues.apache.org/jira/browse/IMPALA-8009
> Project: IMPALA
> Issue Type: Documentation
> Components: Docs
> Affects Versions: Impala 3.2.0
> Reporter: Lars Volker
> Priority: Major
> Labels: documentation, supportability
>
> We should generate documentation for our command line flags. Here's the one that Kudu builds: [https://kudu.apache.org/docs/configuration_reference.html]
> We need to figure out the target format (Kudu uses XML) and whether we want to use something like their tags, too.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-all-unsubscribe@impala.apache.org
For additional commands, e-mail: issues-all-help@impala.apache.org