close
Skip to content

[docs] Supplement documentation overrides HelpText#1119

Open
quic-seaswara wants to merge 1 commit intomainfrom
supplemental_text
Open

[docs] Supplement documentation overrides HelpText#1119
quic-seaswara wants to merge 1 commit intomainfrom
supplemental_text

Conversation

@quic-seaswara
Copy link
Copy Markdown
Contributor

No description provided.

Signed-off-by: Shankar Easwaran <seaswara@qti.qualcomm.com>
@quic-seaswara quic-seaswara requested a review from parth-07 April 30, 2026 16:15
Copy link
Copy Markdown
Contributor

@parth-07 parth-07 left a comment

Choose a reason for hiding this comment

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

We need to update the sysroot documentation in docs/userguide/CommandLineOptionsSupplements/sysroot.rst.in because it assumed that the supplement docs are appended to the tablegen help text.

Additionally, should we rename CommandLineOptionsSupplements to CommandLineOptionsDocs because now the CommandLineOptionsSupplements documentation is replacing the help text instead of supplementing it.

help=(
"Directory containing supplemental RST documentation for options. "
"Each file must be named <option-name>.rst.in (without any prefix); "
"its contents are appended after the auto-generated HelpText."
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.

We need to update this as well.

@quic-seaswara
Copy link
Copy Markdown
Contributor Author

Thanks for the review!

@quic-seaswara
Copy link
Copy Markdown
Contributor Author

We need to update the sysroot documentation in docs/userguide/CommandLineOptionsSupplements/sysroot.rst.in because it assumed that the supplement docs are appended to the tablegen help text.

Additionally, should we rename CommandLineOptionsSupplements to CommandLineOptionsDocs because now the CommandLineOptionsSupplements documentation is replacing the help text instead of supplementing it.

Can we rename this to OverrideCommandLineOptionDocs ?

@parth-07
Copy link
Copy Markdown
Contributor

parth-07 commented May 5, 2026

Can we rename this to OverrideCommandLineOptionDocs ?

Yes, this sounds good to me. I think I prefer CommandLineOptionDocsOverrides more, but both works.

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